Markdown 記法早見表 — ライブプレビュー付き
すべての Markdown 要素をソースと表示結果で掲載。拡張記法(表、タスクリスト、脚注、数式、Mermaid、アラート)、9 プラットフォームの対応表、ライブで試せるプレイグラウンド付き。
最終確認日:2026-10-18 に CommonMark 0.31.2、GFM 仕様、GitHub・GitLab・Obsidian・Slack・Jira の書式ドキュメント と照合。出典:CommonMark spec 0.31.2, GitHub Flavored Markdown spec, GitHub writing and formatting docs, GitLab Flavored Markdown, Obsidian help, Slack message formatting, Jira text formatting notation。
基本の記法(CommonMark 対応環境ならどこでも使える)
以下の要素は CommonMark の仕様に含まれているため、GitHub、GitLab、VS Code、Obsidian、静的サイトジェネレーター、ほとんどのドキュメントツールで同じように動作します。
# を 1〜6 個書き、その後に半角スペースを入れます。# の見出しは 1 文書に 1 つにして、レベルを飛ばさないでください。スクリーンリーダーや目次はこの順序を頼りにしています。
# Heading 1 ## Heading 2 ### Heading 3 #### Heading 4
古い「setext」形式で、レベル 1 と 2 のみ。段落の下に --- の行を置くと見出しになるため、水平線のつもりだと驚くことがあります。--- の前には空行を入れましょう。
Heading 1 ========= Heading 2 ---------
空行で段落を区切ります。段落内の 1 つの改行は 1 行につなげられます(改行の項目で触れた例外を除く)。
First paragraph, which can wrap across several source lines. Second paragraph after a blank line.
First paragraph, which can wrap across several source lines.
Second paragraph after a blank line.
段落を変えずに改行するには、行末に半角スペースを 2 つ、またはバックスラッシュを置きます。GitHub のコメント、Obsidian(初期設定)、Slack、Discord では、改行がすべてそのまま改行として扱われます。
Two trailing spaces make a break. A trailing backslash\ works too.<br>So does an HTML br.
Two trailing spaces
make a break.
A trailing backslash
works too.
So does an HTML br.
アスタリスクは単語の途中でも効きますが、アンダースコアは効きません(snake_case_names はそのまま表示)。そのため多くのスタイルガイドでは * が推奨されています。
**bold** or __bold__ *italic* or _italic_ ***bold italic*** in**side**word works with *, not with _
bold or bold
italic or italic
bold italic
insideword works with *, not with _
各行の先頭に > を付けます。引用の中にはリストやコードなど、ほかの Markdown を何でも入れられます。
> Quoted text. > Still quoted. > > > Nested quote.
Quoted text. Still quoted.
Nested quote.
-、*、+ のどれでも使えます。1 つのリストで混在させないでください(記号が変わると新しいリストになります)。
- Item - Item - Nested (indent 2 spaces) - Item
- Item
- Item
- Nested (indent 2 spaces)
- Item
最初の番号が開始番号になり、以降の番号は無視されます。そのため全行を「1.」にしておけば、項目を並べ替えても自動で番号が振り直されます。
1. First 1. Second 1. Third 3. Starts at three 4. Four
First
Second
Third
Starts at three
Four
追加の内容は、項目テキストの 1 文字目にそろえてインデントします(「1. 」の後ならスペース 3 つ)。
1. Install: ```sh npm install marked ``` 2. Indent continuation lines to the item text.
Install:
npm install markedIndent continuation lines to the item text.
バッククォート内の Markdown は解釈されません。
Run `npm test` now. Use ``double `backticks` `` when the code contains one.
Run npm test now.
Use double `backticks` when the code contains one.
バッククォート 3 つ(または ~~~)をそれぞれ単独の行に置きます。開始フェンスの後の単語で言語を指定すると、GitHub、GitLab、Obsidian、Discord でシンタックスハイライトされます。
```js const answer = 42; console.log(answer); ```
const answer = 42;
console.log(answer);
元々の記法です。フェンスのほうがわかりやすく言語も指定できますが、旧 Reddit が理解できるのはインデント形式だけです。
Paragraph.
four spaces of indent
make a code blockParagraph.
four spaces of indent
make a code block
-、*、_ のいずれかを 3 つ以上、単独の行に書きます。上には空行を入れます。
Above --- Below (also *** or ___)
Above
Below (also *** or ___)
山括弧の形式は CommonMark の自動リンクです。URL 内のスペースは %20 と書くか、URL 全体を <…> で囲む必要があります。
[Link text](https://freetoolsforweb.com) [With a title](https://freetoolsforweb.com "Hover text") [Relative link](/tools/regex-cheat-sheet) <https://example.com>
長い URL を本文から追い出せます。定義は文書内のどこに置いてもよく、表示はされません。
GitHub と GitLab では、すべての見出しに自動で ID が付きます。小文字化され、スペースはハイフンに、記号は削除されます(「## Install & Run」は #install--run になります)。Obsidian では代わりに [[#見出し]] を使います。
[Jump to tables](#md-tables)
リンクの前に ! を付けた形です。[ ] 内のテキストは代替テキストなので、画像が見えない人のために内容を説明しましょう。Markdown にはサイズ指定の記法がないため、HTML が使える環境では <img width="200"> を使います。
バックスラッシュを付けると、ASCII 記号をそのまま表示できます:\ ` * _ { } [ ] ( ) # + - . ! |
\*not italic\* \# not a heading 1\. not a list
*not italic* # not a heading 1. not a list
CommonMark では使用可能です。GitHub と GitLab は安全なサブセットのみ残し(script、style、イベントハンドラーは不可)、Slack、Discord、Reddit、Notion ではテキストとして表示されます。
Press <kbd>Ctrl</kbd> + <kbd>C</kbd>, H<sub>2</sub>O, x<sup>2</sup>.
Press Ctrl + C, H2O, x2.
HTML コメントはソースには残りますが、HTML が使える環境では表示されません。
Visible. <!-- Not rendered: notes for editors --> Also visible.
Visible.
Also visible.
拡張記法(GFM など)
CommonMark には含まれません。対応状況はまちまちなので、GitHub 以外で使う前に互換性一覧表を確認してください。
2 行目は必須で、コロンで配置を指定します。ソース上で列をそろえる必要はありません。パイプ文字そのものは \| とエスケープします。セルの結合や複数行のセルは使えません(GitHub ではセル内で <br> を使います)。
対応環境: GFM、GitLab、Obsidian、Reddit、Notion(貼り付け時)
| Left | Centre | Right | | :--- | :----: | ----: | | a | b | 1 | | `c` | **d** | 22 |
| Left | Centre | Right |
|---|---|---|
| a | b | 1 |
c |
d | 22 |
GitHub と GitLab では、Issue やプルリクエスト内のチェックボックスをクリックでき、ソースも更新されます。
対応環境: GFM、GitLab、Obsidian、Notion([] ショートカット)
- [x] Write the draft - [ ] Review - [ ] Publish
- Write the draft
- Review
- Publish
チルダ 2 つならどこでも使え、GitHub は 1 つでも可。Slack は ~チルダ 1 つ~、Jira は -ハイフン- を使います。
対応環境: GFM、GitLab、Obsidian、Discord、Reddit、Notion
~~no longer true~~
no longer true
GFM では URL や www. で始まるアドレスをそのまま書くとリンクになります。素の CommonMark では <…> で囲まない限りテキストのままです。
対応環境: GFM、GitLab、Obsidian、Slack、Discord、Reddit
Visit https://freetoolsforweb.com or www.example.com.
Visit https://freetoolsforweb.com or www.example.com.
定義はどこに書いても構いません。脚注は参照された順に番号が振られ、末尾にまとめて表示されます。Obsidian にはインライン脚注 ^[このように] もあります。
対応環境: GFM、GitLab、Obsidian(CommonMark は非対応)
アンカーを自分で設定します。Pandoc、PHP Markdown Extra、Hugo、Jekyll(kramdown)、MkDocs、Docusaurus が対応。GitHub と GitLab では無視されて波括弧がそのまま表示され、自動 ID が使われます。
対応環境: Pandoc、Hugo、Jekyll、MkDocs、Docusaurus(GitHub・GitLab は非対応)
### Install {#setup}Rendered by Pandoc, Hugo or kramdown with id="setup", so /page#setup links here.
名前をコロンで囲みます。GitHub、Slack、Discord、Notion ではコロンを入力すると絵文字ピッカーが開きます。絵文字そのものを貼り付ければどこでも使えます。
対応環境: GitHub、GitLab、Slack、Discord(Obsidian はプラグインなしでは非対応、CommonMark も非対応)
Ship it :rocket: :+1: :tada:
Ship it 🚀 👍 🎉
インラインは TeX を $ で囲み、独立した数式ブロックは $$ を使います。GitHub は $`…`$ や ```math ブロックにも対応し、GitLab も同じ形式に対応しています。Notion ではインライン数式に $$…$$ を使います。
対応環境: GitHub、GitLab、Obsidian、Notion(独自記法)
Inline: $E = mc^2$
$$
\sum_{i=1}^{n} i = \frac{n(n+1)}{2}
$$Inline: E = mc2
∑i=1n i = n(n+1) ⁄ 2
言語を mermaid にしたコードブロックが図になります。フローチャート、シーケンス図、クラス図、状態遷移図、ガントチャート、ER 図に対応。
対応環境: GitHub、GitLab、Obsidian、Notion(Mermaid コードブロック)
```mermaid
flowchart LR
A[Write] --> B{Review}
B -->|ok| C[Publish]
B -->|changes| A
```(changes loop back to Write)
GitHub には NOTE、TIP、IMPORTANT、WARNING、CAUTION の 5 種類があります。GitLab(17.10 以降)も同じ記法に対応。Obsidian はさらに多くの種類に加え、独自タイトル(> [!tip] タイトル)や折りたたみ(> [!faq]-)にも対応しています。
対応環境: GitHub、GitLab 17.10 以降、Obsidian(それ以外では通常の引用)
> [!NOTE] > Useful information. > [!WARNING] > Critical content that needs attention.
Useful information.
Critical content that needs attention.
HTML ですが広く対応しています。中の Markdown の前後に空行を入れないと解釈されません。
対応環境: GitHub、GitLab、Obsidian、ほとんどの静的サイトジェネレーター
<details> <summary>Click to expand</summary> Hidden **Markdown** content. </details>
Click to expand
Hidden Markdown content.
Obsidian と一部のエディター(Typora、iA Writer)で使えます。GitHub ではイコール記号がそのまま表示されます。HTML が使える環境では <mark> を使いましょう。
対応環境: Obsidian、Typora(GitHub は非対応)
This is ==highlighted== text.
This is highlighted text.
互換性:CommonMark、GitHub、GitLab、Obsidian、Notion、Slack、Discord、Reddit、Jira
✓ そのまま使える · ~ 別の記法なら使える、または一部のみ対応(注記を参照) · ✗ 使えない。Notion と Slack の入力欄は Markdown ファイルを表示するのではなく、入力中に Markdown のショートカットを変換します。Jira Data Center のフィールドは Wiki 記法を使い、Jira Cloud のエディターは入力中に Markdown 風のショートカットを受け付けます。
| 機能 | CommonMark | GitHub (GFM) | GitLab | Obsidian | Notion | Slack (mrkdwn) | Discord | Jira wiki | |
|---|---|---|---|---|---|---|---|---|---|
| 見出し # | ✓ 対応 | ✓ 対応 | ✓ 対応 | ✓ 対応 | ~ 一部対応/別の記法 入力中に # 、## 、### のショートカット | ✗ 非対応 *太字* の行で代用 | ~ 一部対応/別の記法 #、##、### のみ | ✓ 対応 | ~ 一部対応/別の記法 h1. 〜 h6. |
| 太字/斜体 | ✓ 対応 | ✓ 対応 | ✓ 対応 | ✓ 対応 | ✓ 対応 | ~ 一部対応/別の記法 *太字* と _斜体_(記号は 1 つ) | ✓ 対応 __下線__ も可 | ✓ 対応 | ~ 一部対応/別の記法 *太字* と _斜体_ |
| 取り消し線 | ✗ 非対応 | ✓ 対応 ~~ または ~ | ✓ 対応 | ✓ 対応 | ✓ 対応 ~テキスト~ または ~~テキスト~~ | ~ 一部対応/別の記法 ~テキスト~ | ✓ 対応 | ✓ 対応 | ~ 一部対応/別の記法 -テキスト- |
| インラインコード | ✓ 対応 | ✓ 対応 | ✓ 対応 | ✓ 対応 | ✓ 対応 | ✓ 対応 | ✓ 対応 | ✓ 対応 | ~ 一部対応/別の記法 {{monospace}} |
| フェンス付きコードブロック | ✓ 対応 | ✓ 対応 | ✓ 対応 | ✓ 対応 | ✓ 対応 | ~ 一部対応/別の記法 ``` は使えるが言語ハイライトなし | ✓ 対応 | ~ 一部対応/別の記法 新 Reddit とアプリで可。old.reddit はスペース 4 つのインデントが必要 | ~ 一部対応/別の記法 {code:java} … {code} |
| シンタックスハイライト | ~ 一部対応/別の記法 言語はレンダラーに渡され、ハイライトするかはレンダラー次第 | ✓ 対応 | ✓ 対応 | ✓ 対応 | ✓ 対応 ブロックで言語を選択 | ✗ 非対応 | ✓ 対応 | ✗ 非対応 | ✓ 対応 {code:language} |
| 引用 > | ✓ 対応 | ✓ 対応 | ✓ 対応 | ✓ 対応 | ~ 一部対応/別の記法 " に続けてスペース。> に続けてスペースはトグルになる | ✓ 対応 | ✓ 対応 >>> でメッセージの残りすべてを引用 | ✓ 対応 | ~ 一部対応/別の記法 bq. または {quote} … {quote} |
| リスト | ✓ 対応 | ✓ 対応 | ✓ 対応 | ✓ 対応 | ✓ 対応 | ~ 一部対応/別の記法 入力欄で「- 」がリストになる。API の mrkdwn にはリスト記法なし | ✓ 対応 | ✓ 対応 | ~ 一部対応/別の記法 * で箇条書き、# で番号、** で入れ子 |
| リンク [text](url) | ✓ 対応 | ✓ 対応 | ✓ 対応 | ✓ 対応 [[wikilinks]] も可 | ~ 一部対応/別の記法 貼り付け時に変換 | ~ 一部対応/別の記法 API メッセージでは <https://url|text> | ✓ 対応 マスクリンク | ✓ 対応 | ~ 一部対応/別の記法 [text|https://url] |
| URL の自動リンク | ~ 一部対応/別の記法 <https://…> のみ | ✓ 対応 | ✓ 対応 | ✓ 対応 | ✓ 対応 | ✓ 対応 | ✓ 対応 | ✓ 対応 | ✓ 対応 |
| 画像  | ✓ 対応 | ✓ 対応 | ✓ 対応 | ✓ 対応 ![[file.png]] も可 | ~ 一部対応/別の記法 インポートまたは貼り付け時 | ✗ 非対応 代わりにアップロード | ✗ 非対応 添付するかリンクを貼る | ✗ 非対応 エディターでアップロード | ~ 一部対応/別の記法 !image.png! |
| 表 | ✗ 非対応 | ✓ 対応 | ✓ 対応 | ✓ 対応 | ~ 一部対応/別の記法 貼り付けた Markdown の表はシンプルな表になる | ✗ 非対応 | ✗ 非対応 | ✓ 対応 | ~ 一部対応/別の記法 ||head|| と |cell| |
| タスクリスト | ✗ 非対応 | ✓ 対応 | ✓ 対応 対象外を示す [~] も可 | ✓ 対応 | ~ 一部対応/別の記法 [] に続けてスペースで To-do になる | ✗ 非対応 | ✗ 非対応 | ✗ 非対応 | ✗ 非対応 |
| 脚注 | ✗ 非対応 | ✓ 対応 | ✓ 対応 | ✓ 対応 インラインの ^[note] も可 | ✗ 非対応 | ✗ 非対応 | ✗ 非対応 | ✗ 非対応 | ✗ 非対応 |
| 見出しアンカー | ✗ 非対応 | ~ 一部対応/別の記法 自動のみ、{#id} は不可 | ~ 一部対応/別の記法 自動のみ | ~ 一部対応/別の記法 [[#Heading]] でリンク | ~ 一部対応/別の記法 代わりにブロックへのリンクをコピー | ✗ 非対応 | ✗ 非対応 | ✗ 非対応 | ~ 一部対応/別の記法 {anchor:name} |
| 絵文字ショートコード :smile: | ✗ 非対応 | ✓ 対応 | ✓ 対応 | ✗ 非対応 プラグインが必要 | ~ 一部対応/別の記法 : を入力するとピッカーが開く | ✓ 対応 | ✓ 対応 | ✗ 非対応 | ~ 一部対応/別の記法 :) :D (y) などのテキスト顔文字 |
| 数式 $…$ | ✗ 非対応 | ✓ 対応 | ✓ 対応 | ✓ 対応 | ~ 一部対応/別の記法 インラインは $$…$$、ブロックは /equation | ✗ 非対応 | ✗ 非対応 | ✗ 非対応 | ✗ 非対応 |
| Mermaid ダイアグラム | ✗ 非対応 | ✓ 対応 | ✓ 対応 | ✓ 対応 | ✓ 対応 Mermaid に設定したコードブロック | ✗ 非対応 | ✗ 非対応 | ✗ 非対応 | ✗ 非対応 Marketplace アプリが必要 |
| コールアウト > [!NOTE] | ✗ 非対応 | ✓ 対応 5 種類 | ✓ 対応 17.10+ | ✓ 対応 種類が多く、折りたたみ可 | ✗ 非対応 /callout を使う | ✗ 非対応 | ✗ 非対応 | ✗ 非対応 | ~ 一部対応/別の記法 {panel} … {panel} |
| 生の HTML | ✓ 対応 | ~ 一部対応/別の記法 安全なサブセットのみ。script、style、iframe は不可 | ~ 一部対応/別の記法 安全なサブセットのみ | ~ 一部対応/別の記法 サニタイズ済みのサブセット | ✗ 非対応 | ✗ 非対応 | ✗ 非対応 | ✗ 非対応 | ✗ 非対応 |
| 1 回の改行 = 改行 | ✗ 非対応 行末にスペース 2 つまたは \ | ~ 一部対応/別の記法 コメントでは可、.md ファイルでは不可 | ~ 一部対応/別の記法 コメントでは可、ファイルでは不可 | ~ 一部対応/別の記法 「Strict line breaks」がオンでなければ可 | ✓ 対応 ブロック内で Shift+Enter | ✓ 対応 | ✓ 対応 | ✗ 非対応 行末にスペース 2 つ | ~ 一部対応/別の記法 改行は可。\\ で強制改行 |
同じ書式、違う記法
ツール間で貼り付けるときにつまずきやすい組み合わせです。Slack と Jira では太字は * 1 つ、Slack のリンクは URL が先に来ます。
| 要素 | Markdown / GFM | Slack mrkdwn | Discord | Jira wiki | |
|---|---|---|---|---|---|
| 太字 | **bold** | *bold* | **bold** | **bold** | *bold* |
| 斜体 | *italic* | _italic_ | *italic* | *italic* | _italic_ |
| 取り消し線 | ~~text~~ | ~text~ | ~~text~~ | ~~text~~ | -text- |
| 下線 | (なし。HTML では <ins>) | (なし) | __text__ | (なし) | +text+ |
| インラインコード | `code` | `code` | `code` | `code` | {{code}} |
| コードブロック | ```js … ``` | ``` … ``` | ```js … ``` | 4-space indent | {code:js} … {code} |
| リンク | [text](https://url) | <https://url|text> | [text](https://url) | [text](https://url) | [text|https://url] |
| 見出し | ## Title | (なし) | ## Title | ## Title | h2. Title |
| 引用 | > text | > text | > text | > text | bq. text |
| 箇条書き | - item | • item (typed) | - item | - item | * item |
| 番号付きリスト | 1. item | 1. item (typed) | 1. item | 1. item | # item |
| ネタバレ(スポイラー) | <details> (HTML) | (なし) | ||text|| | >!text!< | (なし) |
Markdown プレイグラウンド
プレビューとプレイグラウンドはブラウザ内で表示され、入力した内容はどこにも送信されません。 すべての無料ツールを見る.
不具合や改善できそうな点を見つけましたか?いただいたメッセージはすべて読み、すぐに対応します。
この Markdown 早見表は、すべての要素を 2 通りで示します。入力する Markdown と、それがどう表示されるかを並べているので、ソースをコピーすれば結果も予想できます。まず基本(見出し、強調、リスト、リンク、画像、コード)、次に GitHub で多くの人が実際に必要とする拡張記法(表、タスクリスト、取り消し線、脚注、アラート、数式、Mermaid の図)を紹介します。
Markdown は 1 つの言語ではありません。CommonMark が中核を定義し、GitHub と GitLab が独自の拡張を加え、Obsidian と Notion がさらに追加しています。Slack、Discord、Reddit、Jira はそれぞれ Markdown に似た、ルールの異なる記法を使っています。たとえば Slack と Jira では *アスタリスク 1 つ* で太字になります。対応表でどこで何が使えるかを、変換表でチャットやチケット管理ツールごとの正確な記法を確認できます。プレビューはオープンソースの marked ライブラリ(CommonMark + GFM)で表示しており、marked が実装していない機能は GitHub や Obsidian での表示を示しています。最後の小さなプレイグラウンドでは、入力した内容をブラウザ内で表示できます。
使い方
- 要素(表、チェックボックス、脚注、改行)を検索するか、上部のチップからセクションに移動します。
- 各カードの左側の Markdown をコピーします。右側にはその表示結果が出ています。
- GitHub 以外で拡張記法を使う前には対応表を、Slack、Discord、Reddit、Jira に貼り付けるときには変換表を確認します。
- 自分のテキストをプレイグラウンドに貼り付けてプレビューし、HTML をコピーするか .md ファイルをダウンロードします。
よくある質問
Markdown で表を作るには?
パイプで見出し行を書き、次にダッシュの区切り行、続いてデータ行を書きます:| Name | Age |、次に | --- | --- |、次に | Ana | 31 |。区切り行のコロンで配置を指定します(:--- 左揃え、:---: 中央揃え、---: 右揃え)。表は GitHub Flavored Markdown の拡張で、GitHub、GitLab、Obsidian、Reddit、多くのエディターで使えますが、素の CommonMark、Slack、Discord では使えません。
新しい段落にせずに改行するには?
行末にスペースを 2 つかバックスラッシュを置くか、HTML が使える場所なら <br> を使います。CommonMark や GitHub の .md ファイルでは、単独の改行は同じ段落につなげられます。GitHub のコメント、Obsidian(既定の設定)、Slack、Discord はすべての改行を改行として扱うため、同じテキストでも README と Issue で見え方が変わることがあります。
CommonMark と GitHub Flavored Markdown の違いは何ですか?
CommonMark は、元の Markdown 記法を厳密に定めた仕様です。GitHub Flavored Markdown(GFM)はその厳密な上位互換で、表、タスクリスト、取り消し線、拡張された自動リンク、安全でない HTML のフィルターを追加しています。github.com では、さらに GitHub 独自の処理によって、脚注、アラート、数式、Mermaid の図、絵文字ショートコードが GFM の上に追加されます。
Markdown でチェックボックスや ToDo リストを書くには?
未完了のタスクは [ ]、完了したタスクは [x] で始まるリスト項目を使います:- [ ] Review、- [x] Write draft。GitHub と GitLab は Issue やプルリクエストでクリックできるチェックボックスとして表示し、Obsidian は閲覧ビューで切り替えられます。GitLab では該当しないタスクに [~] も使えます。
Slack は Markdown に対応していますか?
部分的に、mrkdwn という独自のルールで対応しています。*太字* はアスタリスク 1 つ、_斜体_、~取り消し線~ はチルダ 1 つ、`コード` と ``` のコードブロック、> 引用、そして API 経由で送るメッセージでは <https://url|text> の形式のリンクが使えます。見出し、表、画像はありません。Slack のメッセージ入力欄は入力中に一部の書式を変換し、Block Kit には標準の Markdown を受け付ける別の markdown ブロックがあります。
Markdown で脚注を付けるには?
参照したい場所に [^1] を置き、文書内の任意の場所に独立した行で定義します:[^1]: 出典。GitHub、GitLab、Obsidian は脚注を使われた順に番号付けし、末尾に戻りリンク付きで一覧表示します。CommonMark、Slack、Discord、Reddit、Notion には脚注がありません。
どこでも同じように表示される Markdown の書き方
• 見出し、リスト、コードブロック、表、HTML ブロックの前後には空行を入れましょう。「なぜ表示されないのか」という問題の多くは、空行が足りないことが原因です。
• インデントではなく、言語を指定したフェンス付きコードブロック(```python)を使いましょう。わかりやすく、シンタックスハイライトも付きます。
• 強調には _ ではなく * を使いましょう。単語内のアンダースコア(snake_case_names)は CommonMark ではそのまま残りますが、古いレンダラーでは異なる扱いになるためです。
• 1 つのリストでは箇条書きの記号を 1 種類に統一しましょう。- から * に切り替えると、新しいリストが始まります。
• 入れ子のリストの内容は、決まった 2 つや 4 つのスペースではなく、親項目のテキストの位置に揃えてインデントしましょう。
• すべての画像に代替テキストを書きましょう。画像が読み込めないときに表示され、スクリーンリーダーで読み上げられます。
GitHub の README の基本
GitHub は、ルート、docs/、.github/ にある README.md を表示します。見出しには自動でアンカーが付き、GitHub はそこから目次を作るので(ファイル表示のアウトラインボタン)、わかりやすい見出し構成がそのまま目次になります。相対リンクや相対パスの画像(./docs/setup.md、./images/demo.png)は github.com で機能し、絶対 URL と違ってフォークや別のブランチでもそのまま使えます。
アラート(> [!NOTE]、> [!WARNING])はインストール時の注意点を目立たせ、Mermaid のコードブロックは編集可能なまま構成図を描き、<details> は設定の全リファレンスのような長いセクションを折りたたみます。最初の画面には、プロジェクトが何か、インストール方法、最小限の例だけを置き、それ以外は下に配置しましょう。
関連する無料ツール
- ChatGPT を Word に — ChatGPT、Claude、Gemini の回答を貼り付ければ、** や # ではなく本物の見出し・表・リストとして Word、Google ドキュメント、メールにコピーできます。
- 文字数カウント — 単語数、文字数、文の数、読了時間を数え、入力しながら X、LinkedIn、Instagram、YouTube、SEO、SMS の上限を確認できます。
- Git 早見表 — 直前のコミットの取り消し、ブランチ名の変更、リモートブランチの削除など、やりたいこと別に整理した Git コマンド。新しい switch/restore と従来のコマンド、危険度バッジ付き。
- 正規表現早見表 — 正規表現のすべてのトークンを、動作する例、JavaScript・PCRE/PHP・Python・Go・Java・.NET での対応状況、入力済みの正規表現テスターを開く「試す」リンク付きで掲載。
- 差分チェッカー — テキスト、コード、JSON ファイルの 2 つのバージョンを比較し、どの行、単語、文字が変わったかを正確に確認できます。