コンテンツにスキップ

Markdown記法チートシート:書き方と表示例の一覧

Markdownの書き方をすぐ確認できる早見表です。コピーするときは、例の texturl を自分の内容に置き換えてください。

要素Markdown表示
見出し# TitleTitle
太字**text**text
斜体*text*text
打ち消し線~~text~~text
リンク[text](url)text
画像![alt](img.png)🖼
箇条書き- item• one
• two
番号付きリスト1. item1. one
2. two
引用> quotequote
インラインコード`code`code
コードブロック```lang…code…
| a | b |a · b
タスクリスト- [ ] task☑ done
☐ todo
区切り線---───

見出しは行頭の # で作ります。# の数が増えるほど、見出しの階層が深くなります。

# 見出し1
## 見出し2
### 見出し3

段落を分けるには、文章の間に空行を1行入れます。単にEnterを1回押しただけでは、表示上は同じ段落になることがあります。

**太字**
*斜体*
~~打ち消し線~~
***太字かつ斜体***

打ち消し線はGitHub Flavored Markdown(GFM)で広まった拡張記法です。環境によっては対応していません。

- 項目A
- 項目B
- 子項目
1. 手順1
2. 手順2
3. 手順3

入れ子にするときは、子項目の前にスペースを入れます。必要なスペース数は表示環境によって異なるため、公開先でも確認してください。

[リンクの文字](https://example.com)
![画像の説明](image.png)

画像の角括弧には、画像が表示されない場合や読み上げ時に内容が伝わる代替テキストを書きます。

> これは引用です。
>
> 複数の段落も引用できます。

インラインコードとコードブロック

Section titled “インラインコードとコードブロック”

短いコマンドやファイル名はバッククォート1つで囲みます。

`npm run build` を実行します。

複数行のコードは、バッククォート3つのコードフェンスで囲みます。開始側に言語名を書くと、対応する環境で色分けされます。

```js
console.log('Hello');
```
| 名前 | 状態 |
|---|---|
| 仕様書 | 完了 |
| テスト | 進行中 |

2行目のハイフンは必須です。列の幅をそろえる必要はありません。

- [x] 完了した項目
- [ ] 未完了の項目

チェックボックスはGFMの拡張記法です。GitHubなどではタスクリストとして表示されます。

記法 CommonMark GitHub 多くのエディタ
見出し・リスト・リンク 対応 対応 対応
拡張 対応 多くが対応
打ち消し線 拡張 対応 多くが対応
チェックボックス 拡張 対応 環境による
HTML 対応範囲あり 一部制限 環境による

「Markdown」と呼ばれていても、すべてのサービスで表示が同じとは限りません。GitHub、VS Code、Notion、Slackなど、最終的に使う環境で確認してください。

AIに渡すMarkdownのチェックポイント

Section titled “AIに渡すMarkdownのチェックポイント”
  • 見出しの階層を飛ばしすぎない。
  • コードやログをコードブロックに入れる。
  • 表の各列に意味の分かる見出しを付ける。
  • リンクテキストを「こちら」だけにしない。
  • 不要になった機密情報は打ち消し線ではなく削除する。