マークダウンプレビューとは？

マークダウンプレビューは、マークダウン(Markdown)構文で書いたテキストをリアルタイムでHTMLレンダリング結果に変換して表示するオンラインツールです。GitHub Flavored Markdown(GFM)を完全にサポートし、テーブル、チェックリスト、自動リンク、コード構文ハイライトなどの拡張構文を含みます。別途ソフトウェアをインストールせずにブラウザですぐにマークダウン文書を作成して結果を確認できるため、READMEファイル作成や技術文書編集に非常に便利です。

• 入力と同時にレンダリングされるリアルタイムプレビュー
• GitHub Flavored Markdown（GFM）の完全サポート
• コードブロックのシンタックスハイライト
• テーブル、チェックリスト、取り消し線などの拡張構文サポート
• 作成した文書をHTMLとしてコピーまたは.mdファイルとしてダウンロード
• マークダウン構文ガイド内蔵で初心者でも簡単に使用可能

使い方

1. 1

   マークダウンの入力

   左側のエディタにマークダウン構文を使用してテキストを入力します。見出しには#、太字には**、リストには-などを使用します。

2. 2

   リアルタイムプレビューの確認

   右側のプレビューエリアで入力したマークダウンがレンダリングされた結果を即座に確認します。

3. 3

   構文ガイドの参照

   構文が思い出せない場合は、内蔵のマークダウン構文ガイドを開いて各構文の使い方と例を確認します。

4. 4

   ファイルの読み込み

   既存の.mdファイルがある場合は、ファイルを開く機能で読み込んで編集・プレビューできます。

5. 5

   結果のエクスポート

   完成した文書を.mdファイルとしてダウンロードするか、レンダリングされたHTMLをコピーして他の場所に貼り付けます。

よくある質問

活用のヒント

• README.mdの作成時にこのツールでプレビューすると、GitHubにアップロードする前にレンダリング結果を確認できます。
• テーブルは|（パイプ文字）と-（ハイフン）で簡単に作成でき、コロン（:）で配置の方向を指定できます。
• 画像を挿入する場合は構文を使用し、Web画像のURLを直接使用できます。
• チェックリストは- [ ]と- [x]でToDoリストを作成でき、プロジェクト管理に便利です。
• コードブロック内ではマークダウン構文をエスケープなしでそのまま表示できるため、構文説明ドキュメントの作成に適しています。