Markdown プレビューツールとは?
Markdown プレビューツールは、左側でMarkdownを作成し、右側でレンダリングされた出力をリアルタイムに確認できる無料のオンライン分割画面エディターです。テーブル、タスクリスト、打ち消し線、囲みコードブロックを含むGitHub Flavored Markdown(GFM)に対応しています。
GitHubリポジトリのREADMEを作成している場合でも、ドキュメントやブログ記事を書いている場合でも、Markdownの構文を学んでいる場合でも、このツールは入力中に即座な視覚的フィードバックを提供します。
Markdown プレビューエディターの使い方
- 左側のエディターペインにMarkdownコンテンツを入力または貼り付けます。右側のプレビューペインは入力に合わせて自動的に更新されます。
- 上部の書式ツールバーを使用して、太字、斜体、見出し、リンク、画像、コードブロック、リストを構文を覚えずに挿入できます。
- 「HTMLをエクスポート」をクリックすると、レンダリングされた出力がクリーンなスタイル付きのスタンドアロンHTMLファイルとしてダウンロードされます。
- 「MDをコピー」をクリックすると、生のMarkdownテキストがクリップボードにコピーされます。
- 下部のMarkdownチートシートを展開して、対応しているすべての構文をクイックリファレンスとして確認します。
対応しているMarkdown機能
このエディターは完全なCommonMark仕様に加え、GitHub Flavored Markdownの拡張機能をサポートしています。見出し(h1〜h6)、太字、斜体、打ち消し線テキスト、順序付き/順序なしリスト、引用ブロック、水平線、インラインコードと囲みコードブロック、リンク、画像、配置付きテーブル、タスクリストのチェックボックスが使用できます。
より良いMarkdownを書くためのコツ
- 見出しは階層的に使用する:タイトルはh1、セクションはh2、サブセクションはh3
- 段落間やリストの前後に空行を入れて正しくレンダリングされるようにする
- 構文ハイライトをサポートするレンダラーでは、言語識別子付きの囲みコードブロックを使う
- フォーマットの問題を早期に発見するために、頻繁にプレビューする
- あまり使わない要素の構文を学ぶために、ツールバーボタンを使う
一般的な使用例
- コミット前にGitHub READMEファイルを作成・プレビューする
- Markdownでドキュメントや技術文書を作成する
- Hugo、Jekyll、Astroなどの静的サイトジェネレーター向けにブログ記事を作成する
- 即時の視覚的フィードバックを使ってMarkdown構文を学習する
- MarkdownをHTMLに変換してウェブサイトやメールに埋め込む