マークダウン チートシート:全21種類のmarkdown 記法 一覧を1ページで
マークダウン チートシートとは、各markdown要素とその正確な記法を1ページで対照できる早見表のことで、公式ドキュメントを開かなくても文書を整形できます。 このページでは全21種類の要素を2つの表に整理しています。1つ目はJohn Gruberが2004年のオリジナル仕様で定義した基本記法10種類、2つ目はCommonMark(2014年)やGitHub Flavored Markdown(2017年)などの後発フレーバーが追加した拡張記法11種類です。掲載している記法例はすべてオンラインmarkdownエディタでも動作し、入力と同時にライブプレビューで表示結果を確認できます。
基本記法
基本記法は2004年のオリジナル設計に含まれる10種類の要素で、どのmarkdownアプリでも同じように表示されます。 この10種類で日常的な文書作成の大部分をカバーできます。見出しとリストで構造を作り、太字と斜体で強調し、リンクと画像で参照を示します。この表の要素だけで書かれた文書は、GitHub、Obsidian、Reddit、Discord、そして2004年以降に作られたあらゆるエディタで正しく表示されます。
| 要素 | Syntax | 表示結果 |
|---|---|---|
| 見出し | # H1 / ## H2 / ### H3 | レベル1から6のセクションタイトル。#1つが1レベルに対応します |
| 太字 | **strong words** | 強調したい語句 |
| 斜体 | *slanted words* | 斜めに傾いた語句 |
| 引用 | > quoted line | 左側に罫線が付いたインデント付きの引用ブロック |
| 番号付きリスト | 1. Step one 2. Step two | 番号付きリスト。番号は連番で表示されます |
| 箇条書きリスト | - First point - Second point | 箇条書きリスト。*や+もマーカーとして使えます |
| コード | `inline code` | 等幅フォントの枠内に表示されるインラインコード |
| 水平線 | --- | セクションを区切る全幅の罫線 |
| リンク | [anchor text](https://example.com) | 「anchor text」と表示されるクリック可能なリンク |
| 画像 |  | アクセシビリティ用のaltテキスト付きの埋め込み画像 |
見出し記号は最後の#の後に半角スペースが必要で、水平線の上には空行が必要です。基本記法の表示崩れは、ほとんどがこの2点が原因です。
拡張記法
拡張記法は2004年のオリジナル仕様に含まれていなかった11種類の要素で、対応状況はアプリが実装しているmarkdownフレーバーによって異なります。 テーブル、フェンス付きコードブロック、タスクリストはGitHub Flavored Markdownで登場し、GitHubが2017年に仕様として正式化しました。脚注、定義リスト、ハイライトは別のフレーバー由来で、表示できるアプリはさらに少なくなります。
| 要素 | Syntax | 表示結果 |
|---|---|---|
| テーブル | | Name | Role | | --- | --- | | Ada | Engineer | | ヘッダー行と列揃えを持つ表 |
| フェンス付きコードブロック | ```json { "id": 1 } ``` | 複数行のコードボックス。シンタックスハイライトも指定できます |
| 脚注 | A claim.[^1] [^1]: The source. | 番号付きの参照と、ページ末尾に表示される注記 |
| 見出しID | ## Pricing {#pricing} | 直リンク用のカスタムアンカーが付いた見出し |
| 定義リスト | Term : Meaning of the term | 用語の行の下に、インデント付きで定義が表示されます |
| 打ち消し線 | ~~old figure~~ | |
| タスクリスト | - [x] Ship the draft - [ ] Review edits | チェック済みと未チェックのボックスが並ぶチェックリスト |
| 絵文字ショートコード | :tada: | 対応する絵文字。🎉 |
| ハイライト | ==key phrase== | 色付きの背景で表示されるフレーズ |
| 下付き文字 | H~2~O | H₂O |
| 上付き文字 | x^2^ | x² |
対応状況はアプリごとに異なります。GitHubはテーブル、フェンス付きコードブロック、タスクリスト、打ち消し線、脚注、絵文字ショートコードを表示しますが、ハイライト、下付き文字、上付き文字は無視します。Obsidianはテーブル、脚注、タスクリスト、打ち消し線、ハイライトに対応します。Discordは太字、斜体、打ち消し線、コードブロックを受け付けますが、テーブルと脚注には対応していません。表示先のプラットフォームが分からない場合は、基本記法の10種類が安全な選択です。
このチートシートの使い方
左の列で要素を探し、中央の列の記法をコピーして、プレースホルダーのテキストを自分の内容に置き換えてください。 表示結果の列で出力イメージを確認できるため、コピーする前に目的の要素かどうか判断できます。拡張記法の表にある要素は、先に対応状況の注記を確認してください。GitHubで表示される脚注も、Discordでは消えてしまいます。
記法を確かめる最速の方法は、オンラインmarkdownエディタに貼り付けることです。ライブプレビューは各要素を数ミリ秒で表示するため、崩れたテーブルや閉じ忘れの**マーカーはその場で見つかります。markdownを毎日使う人なら、基本記法の表は1週間ほどで自然に覚えてしまいます。手元に置いておく価値があるのは、むしろ拡張記法の表のほうです。
ダウンロードと印刷
このマークダウン 早見表はA4用紙1枚に収まり、.mdファイルとしてダウンロードできるため、ノートアプリに保存したり、印刷してデスクに置いたりできます。 ダウンロードしたファイル自体が有効なmarkdownで、GFMテーブルに対応するアプリであれば2つの表とも正しく表示されます。エディタでも、Obsidianでも、GitHubリポジトリでも、開いた先でレイアウトは保たれます。
よくある質問
基本記法と拡張記法の違いは何ですか?
基本記法は2004年のオリジナル仕様に含まれる10種類の要素を指し、拡張記法は後発のフレーバーが追加した11種類の要素を指します。 基本記法はすべてのmarkdownアプリが対応しています。拡張記法はフレーバー次第です。CommonMarkは2014年にコア動作を標準化し、GFMは2017年の仕様でテーブル、タスクリスト、打ち消し線を追加しました。
すべてのmarkdownアプリが拡張記法に対応していますか?
いいえ。拡張記法の対応状況はアプリごとに異なり、11種類すべてを表示できるアプリは1つもありません。 GitHubはハイライトと下付き文字を、Discordはテーブルと脚注をそれぞれ表示できず、3つの中ではObsidianが最も広い範囲をカバーしています。複数のプラットフォームに向けた文書は、基本記法とGFMテーブルの範囲に収めるのが安全です。
markdownの習得は難しいですか?
いいえ。markdownの要素は全部で21種類しかなく、ほとんどの文書は基本の10種類で書けます。 見出しの#、太字の**、リストの-だけで実際の利用の大半をまかなえます。ライブプレビュー付きのエディタなら間違いがその場で分かるため、ほとんどの人は1回の練習で自然なmarkdownを書けるようになります。