リファレンス

Markdown チートシート

Q: 見出しが表示されないのはなぜですか？

最も多い原因は、井桁の後ろの半角スペース抜けです。#見出し ではなく # 見出し と書いてください。次に多いのが見出しの上に空行がないケースで、一部のパーサーは前の段落の一部として扱います。

必要な Markdown 記法をすべて掲載。左が書き方、右が描画結果です。CommonMark と GitHub Flavored Markdown の拡張に対応。

見出し

6 段階あります。前の段落に取り込まれないよう、見出しの前に空行を入れてください。

記法

表示結果

最上位の見出し

# Heading level 1

Heading level 1

セクション見出し

## Heading level 2

Heading level 2

小見出し

### Heading level 3

Heading level 3

レベル 1・2 の別記法

Heading level 1
===============

Heading level 2
---------------

Heading level 1

Heading level 2

強調

アスタリスクとアンダースコアのどちらでも使えます。単語の内側ではアスタリスクのほうが安全です。

記法

表示結果

太字

**bold text**

bold text

斜体

*italic text*

italic text

太字と斜体

***bold and italic***

bold and italic

打ち消し線（GFM）

~~struck through~~

~~struck through~~

リンクと画像

画像は先頭に感嘆符を付けたリンクです。代替テキストはアクセシビリティと SEO の両方に効きます。

記法

表示結果

インラインリンク

[Markdown to Image](https://markdowntoimage.com)

Markdown to Image

ツールチップ付きリンク

[Markdown to Image](https://markdowntoimage.com "Convert Markdown")

Markdown to Image

画像

![A mountain at dusk](/photo.jpg)

A mountain at dusk

自動リンク

<https://markdowntoimage.com>

https://markdowntoimage.com

コード

開始フェンスの後ろに言語名を書くとシンタックスハイライトが付きます。

記法

表示結果

インラインコード

Run `npm install` first.

Run npm install first.

コードブロック

```
plain code block
```

plain code block

ハイライト付きコードブロック

```js
const total = items.length;
```

const total = items.length;

引用

引用の中にはリストやコードなど、他の Markdown を入れられます。

記法

表示結果

引用

> Everything should be made as
> simple as possible.

Everything should be made as simple as possible.

入れ子の引用

> Outer quote
>
>> Inner quote

Outer quote
Inner quote

表

ソース上で列を揃える必要はありません。区切り行のコロンで揃え方を指定します。

記法

表示結果

基本の表

| Format | Size |
| --- | --- |
| PNG | 240 KB |
| PDF | 96 KB |

Format	Size
PNG	240 KB
PDF	96 KB

列の揃え方

| Left | Center | Right |
| :--- | :----: | ----: |
| a | b | c |

Left	Center	Right
a	b	c

その他の記法

ハイフン 3 つ以上で水平線になります。行末に半角スペース 2 つで、段落を変えずに改行できます。

記法

表示結果

水平線

---

強制改行

First line ends here.\
Second line starts here.

First line ends here.
Second line starts here.

特殊文字のエスケープ

\*not italic\*

*not italic*

脚注（GFM）

Text with a note.[^1]

[^1]: The note itself.

Text with a note.¹

トラブルシューティング

サポート

Markdown と GitHub Flavored Markdown の違いは何ですか？

GitHub Flavored Markdown（GFM）は CommonMark の上位互換で、表・タスクリスト・打ち消し線・脚注・URL の自動リンクが加わります。このページで GFM と記した記法には、それらの拡張に対応したレンダラーが必要です（最近のものはほぼ対応しています）。

見出しが表示されないのはなぜですか？

最も多い原因は、井桁の後ろの半角スペース抜けです。#見出しではなく # 見出しと書いてください。次に多いのが見出しの上に空行がないケースで、一部のパーサーは前の段落の一部として扱います。

段落を変えずに改行するには？

行末に半角スペースを 2 つ入れるか、行末にバックスラッシュを置きます。単なる改行はほとんどのパーサーで空白に畳まれ、空行を入れると新しい段落になります。

アスタリスクやアンダースコアをそのまま表示するには？

直前にバックスラッシュを置きます。\*文字\* と書けば斜体にならず *文字* と表示されます。バッククォート、井桁、角括弧など他の Markdown 文字も同様です。

Markdown の表は列を揃える必要がありますか？

必要ありません。ソース上で縦棒が揃っていなくても、レイアウトはレンダラーが処理します。揃えるのは原文を読みやすくするためだけです。重要なのはヘッダー下の区切り行です。