Markdown構文ガイド
実用的なMarkdown構文リファレンスと使用例
構文を試す
構文リファレンス
Markdown構文とは？
Markdownは2004年にJohn Gruberが作成した軽量なプレーンテキスト書式設定言語です。シンプルな記号や文字を使ってテキストをマークアップするため、生の形でも見やすくHTMLに変換できるコンテンツを書きやすくします。Markdownはドキュメント、READMEファイル、ブログ、そしてシンプルで読みやすい書式設定が必要なコンテンツの標準になっています。HTMLのように開始タグと終了タグが不要で、強調にはアスタリスク、リストにはハイフンといった直感的なマーカーを使うため、プレーンテキストが打てる人なら誰でも使えます。
CommonMarkは最も広く受け入れられているMarkdown仕様で、パーサーが構文をどのように解釈すべきかを定義しています。異なるプラットフォーム間でMarkdownの動作を標準化するためのコミュニティの取り組みから生まれました。元の仕様では多くのエッジケースが未定義のままでした。CommonMark準拠の構文を学ぶことで、GitHub、GitLab、Discord、Slack、Reddit、Stack Overflowなど数十のプラットフォームで一貫してコンテンツがレンダリングされます。John Gruberの元のMarkdown仕様は基盤として残っており、GitHub Flavored Markdownなどの拡張機能がタスクリスト、取り消し線テキスト、表などの機能を追加しています。
モダンなMarkdownは特定のプラットフォームに合わせたいくつかのフレーバーがあります。GitHub Flavored Markdown（GFM）は表、チェックボックス、自動リンクを追加します。GitLab Markdownも同様の拡張に加えてダイアグラムをサポートします。CommonMarkのコア構文を学ぶことで、どこでも使えるポータブルな基盤が得られ、必要に応じてプラットフォーム固有の拡張機能を活用できます。
Markdown構文ガイドの使い方
以下の手順でMarkdown構文を学び、試してください。各ステップはこのページの実際のパネルを使用します。
貼り付け、アップロード、またはサンプルの読み込み
左側の構文を試すパネルにMarkdownを貼り付けるか、アップロードをクリックして.mdファイルを読み込んでください。サンプルをクリックするとサブスクライバーAPIドキュメントの例を確認できます。右側の構文リファレンスパネルにはCommonMarkとGFMのパターンが表示されます。
練習とリファレンス参照
見出し、強調、リスト、リンク、表、コードブロックのリファレンスを活用してください。左パネルに例をコピーして試すことができます。CommonMarkとGitHub Flavored Markdown拡張をカバーしています。
コピーまたはダウンロード
コピーまたはダウンロードをクリックしてリファレンスを保存してください。クリアで最初からやり直せます。すべての処理はブラウザ内で行われます。
実際の使用シーン
ドキュメントの執筆
テクニカルドキュメント、APIリファレンスガイド、ソフトウェアドキュメントはほぼ普遍的にMarkdownで書かれています。Pythonドキュメント、Node.jsガイド、そして多くのオープンソースプロジェクトがドキュメントサイトにMarkdownを使用しています。構文リファレンスがあれば、複数の見出しレベル、コード例、相互参照を含む複雑なドキュメントを書く際に生産性を維持できます。
READMEとプロジェクトファイル
すべてのGitHubプロジェクトには、プロジェクトの説明、使用方法、インストール、コントリビューションガイドラインを記述したREADME.mdファイルがあります。これらのファイルは全てMarkdownで書かれており、ユーザーが最初に目にするものです。機能比較のための表、例のためのコードブロック、書式設定されたリストはREADMEの標準的な要素です。
コンテンツ作成と公開
Jekyll、Hugo、GhostなどのブログプラットフォームはMarkdownでコンテンツを受け付けます。Mediumスタイルのプラットフォーム、静的サイトジェネレーターはすべてMarkdownを主要な入力形式として使用しています。構文を知ることで、より速く書けるようになり、公開するすべてのコンテンツで一貫した書式設定を維持できます。
コラボレーションコミュニケーション
Slack、Discord、GitHub Issue、プルリクエストのコメント、フォーラム投稿はすべてMarkdownの書式設定をサポートしています。コードレビューやバグ報告、チャットでのコラボレーションの際に、Markdownを使えば会話の流れを妨げることなくメッセージを明確に書式設定できます。構文の基本知識は日々のワークフローで時間を節約します。
よくある質問（FAQ）
MarkdownにHTMLを使用できますか？
はい、MarkdownでHTMLを混在させることができます。Markdownがサポートしていない機能が必要な場合、HTMLを直接書くと出力にそのまま反映されます。ただし、ソースの移植性と可読性が低下します。CommonMark仕様によると、HTMLブロックとインラインHTMLは認識されて変更なしに通過します。控えめに使用してください—通常はMarkdown構文で十分です。
強調のためのアスタリスクとアンダースコアの違いは？
CommonMarkでは機能的に同じです—*テキスト*と_テキスト_の両方がイタリック体を生成し、**テキスト**と__テキスト__の両方が太字を生成します。選択はスタイルの問題です。多くのチームは一貫性のためにアスタリスクを好み、ほとんどのキーボードで入力しやすいためです。アンダースコアは強調に似たパターンを持つ単語（例：「file_name_here」）で問題が生じる場合があるため、アスタリスクが推奨されることが多いです。
Markdownでの改行はどのように機能しますか？
これはよくある混乱の源です。ソース内の単一の改行はスペースとして扱われ、行は次の行と結合されます。実際の改行（HTMLの<br>）を作成するには、Enterを押す前に行末に2つのスペースを追加するか、改行の前にバックスラッシュを使用します。段落区切りには空白行（2つの連続した改行）を使用します。CommonMark仕様はこれを詳細に説明しています。
Markdownの表はどこでもサポートされていますか？
いいえ。表はGitHub Flavored Markdownやその他の拡張の一部であり、CommonMark仕様には含まれていません。ほとんどのモダンなプラットフォーム（GitHub、GitLab、Discord）ではサポートされていますが、一部のパーサーはパイプ構文を無視します。どこでも表が機能する必要がある場合は、対象プラットフォームがGFMをサポートしているか確認するか、別のアプローチを検討してください。
特殊文字をエスケープするには？
Markdownで特殊な意味を持つ文字の前にバックスラッシュ（\）を置きます。対象文字：バックスラッシュ自体（\）、バックティック（`）、アスタリスク（*）、アンダースコア（_）、波括弧（{}）、角括弧（[]）、丸括弧（()）、ハッシュ（#）、プラス（+）、マイナス（-）、ピリオド（.）、感嘆符（!）。例えば、\*イタリックではない\*とすると、アスタリスクがそのまま表示されます。CommonMarkのバックスラッシュエスケープでは特定の文字のみエスケープが必要です。
Markdownでコードを書式設定する最良の方法は？
インラインコードには単一バックティックを使用します: `ここにコード`。コードブロックにはオプションの言語タグ付きトリプルバックティック（```javascript）を使用してシンタックスハイライトを有効にします。インデントによるコードブロックは避けてください—フェンスコードブロックの方が明確で移植性が高いです。バックティックを含むコードを表示する場合は、より多くのバックティックで囲みます: ` ``バックティック`` `。CommonMark仕様のコードスパンとフェンスコードブロックを参照してください。