Markdownを入力すると、ここにプレビューが表示されます。
Developer Utility
Markdown Preview
Markdown記法を入力すると、見出し、リスト、コードブロック、表、引用、リンクをHTMLとしてリアルタイムにプレビューし、変換結果をコピーできます。
Markdown入力
左側にMarkdownを入力すると、右側でHTMLプレビューを確認できます。
Markdownの活用方法
Markdownはシンプルな記法で構造化された文書を素早く作成できるため、開発文書やブログの下書きによく使われます。
プロジェクト紹介、インストール手順、使い方、コード例をMarkdownで作成し、結果をプレビューできます。
見出し、リスト、引用、コードブロックを使って、開発ブログ記事の下書きを素早く整理できます。
Markdownで作成した内容をHTML形式に変換し、Webページや文書編集作業に活用できます。
ヘルプ
Markdown Previewとは?
Markdown Previewは、Markdown記法で書いたテキストをHTML形式でリアルタイムにプレビューできる開発者向け文書作成ユーティリティです。
README.md、GitHub文書、ブログ下書き、開発ノート、リリースノート、API文書の作成時に、出力画面を素早く確認できます。
対応記法
- 見出し: #, ##, ###
- リスト: -, *, 1.
- 強調: **太字**, *斜体*
- コード: インラインコード、コードブロック
- リンク、引用、表
Markdownはどこでよく使われますか?
MarkdownはGitHub README、開発文書、ブログ下書き、プロジェクトガイド、リリースノート、API文書など、構造が必要なテキスト作成によく使われます。
コードブロックはどう書きますか?
バッククォート3つを使ってコードブロックを作成できます。たとえば```jsで開始し、コードを書いたあと、再びバッククォート3つで閉じます。
表はどう書きますか?
パイプ文字|と区切り線---を使って表を作成できます。1行目はヘッダー、2行目は区切り線、その下からデータ行として記述します。
コピーしたHTMLはどこで使えますか?
変換されたHTMLは、Webページ編集、ブログエディター、文書エディター、テンプレート作業に活用できます。ただし、サービスごとに許可されるHTMLタグが異なる場合があるため、適用後に表示を確認してください。
危険なHTMLを削除するオプションとは?
Markdown内に含まれるscriptタグやイベント属性などの危険要素を削除し、プレビュー領域で実行されないようにするオプションです。
機密情報を入力してもよいですか?
このツールはブラウザ上でMarkdownをプレビューする用途です。それでもAPIキー、パスワード、個人情報、内部文書の内容は、入力前に削除またはマスキングすることをおすすめします。