Markdownの書き方と活用シーン
MarkdownはプレーンテキストをHTMLに変換するための軽量マークアップ言語です。GitHubのREADME・技術ブログ・ドキュメント・メモ管理など、エンジニアの日常で広く使われています。
Markdownの基本記法
# で見出し(H1〜H6)、** ** で太字、* * で斜体、`で等幅コード、```でコードブロック、- や*でリスト、1. 2. 3. で番号付きリスト、[テキスト](URL) でリンク、 で画像を表現します。GitHubではこれらに加えてテーブル・打消し線・チェックリストなどのGFM(GitHub Flavored Markdown)拡張が使えます。
コードブロックのシンタックスハイライト
```の後に言語名を指定するとシンタックスハイライトが適用されます。 ```javascript const x = 1 ``` のように書くことでJavaScriptのコードが色分け表示されます。Markdown Previewでは JS・TS・Python・HTML・CSS・JSON・Shellのハイライトに対応しています。
目次(TOC)の自動生成
長いMarkdownドキュメントでは見出しから目次を自動生成して各セクションへジャンプできると便利です。Markdown Previewでは見出しH1〜H3から目次を自動生成し、クリックで対応箇所にスクロールします。技術文書・仕様書・READMEを書きながら構成を把握するのに役立ちます。
HTMLエクスポートの活用(デスクトップ版)
デスクトップ版Markdown PreviewではMarkdownをHTMLファイルとしてエクスポートできます。スタイル付きのHTMLを書き出せるため、メールで送付する技術ドキュメントや社内向けの静的HTMLページを手軽に作成できます。.mdファイルのドラッグ&ドロップ読み込みにも対応しています。