Markdown記法チートシート

LWP | Markdown記法チートシート

LWP TECHNICAL ARTICLE | 189

Markdown記法チートシート

本資料は、出典を明記いただければ、商用・非商用を問わず、ご自由に複製・改変・再配布していただけます。なお、著作権表示は改変せず、そのまま記載してご利用くださいますようお願いいたします。

記事要約

Markdownで頻繁に使う見出し、段落、強調、リスト、引用、コード、リンク、画像、表を、入力例と注意点を並べて引けるリファレンスです。標準MarkdownとGitHub Flavored Markdownなどの拡張機能を区別し、技術文書で迷いやすい書き方もまとめます。

本記事の対象とゴール

Markdownを初めて使う方から、記法を素早く確認したい実務利用者までを対象とします。必要な記法を探し、そのまま転記して使いながら、処理系ごとの差にも注意できることをゴールとします。

Markdownは、プレーンテキストに簡単な記号を加えて、見出し・箇条書き・リンク・表などを表現する記法です。

1. 見出し

# 見出し1

## 見出し2

### 見出し3

#### 見出し4

##### 見出し5

###### 見出し6

# の数で階層を表します。

通常は、

# 文書タイトル

## 大見出し

### 小見出し

程度までにすると読みやすくなります。

2. 段落

文章をそのまま書けば段落になります。

これは第1段落です。

これは第2段落です。

段落を分けるには、間に空行を入れます。

3. 改行

通常のMarkdownでは、単なる改行は段落内の改行として扱われないことがあります。

確実に改行する場合は、行末に半角スペースを2個入れます。

1行目です。

2行目です。

HTMLが使える環境なら、

1行目です。<br>

2行目です。

でも改行できます。

4. 太字

**太字**

表示：

太字

5. 斜体

*斜体*

表示：

斜体

6. 太字＋斜体

***太字＋斜体***

表示：

*太字＋斜体*

7. 取り消し線

GitHub Flavored Markdownなどで使用できます。

~~取り消し線~~

表示：

~~取り消し線~~

8. 箇条書き

- 項目1

- 項目2

- 項目3

または、

* 項目1

* 項目2

* 項目3

通常は - を使うと統一しやすくなります。

9. 箇条書きの階層

- Excel

  - 数式

  - VBA

  - Power Query

- Google Workspace

  - Google Sheets

  - Apps Script

インデントして階層を作ります。

10. 番号付きリスト

1. 項目1

2. 項目2

3. 項目3

Markdownでは、

1. 項目1

1. 項目2

1. 項目3

と書いても、自動的に連番として表示される処理系があります。

11. チェックリスト

GitHub Flavored Markdownなどで使用できます。

- [ ] 未完了

- [x] 完了

- [ ] 確認する

表示：

[ ] 未完了
[x] 完了
[ ] 確認する

12. 引用

> これは引用です。

表示：

これは引用です。

複数行の場合：

> これは引用です。

> 2行目も引用です。

13. 引用の入れ子

> 第1階層

> > 第2階層

14. インラインコード

文章中の関数名、変数名、数式、コマンドなどに使います。

`Table.AddColumn`

表示：

Table.AddColumn

15. コードブロック

バッククォート3個で囲みます。

```

ここにコードを書く

```

16. 言語を指定したコードブロック

```python

print("Hello")

```

PowerShell：

```powershell

Get-ChildItem

```

JavaScript：

```javascript

console.log("Hello");

```

SQL：

```sql

SELECT *

FROM Customers;

```

Power Query M：

```powerquery

let

    Source = Excel.CurrentWorkbook()

in

    Source

```

処理系によっては m や powerquery が認識されない場合があります。

17. リンク

[OpenAI](https://openai.com/)

18. URLをそのままリンクにする

https://example.com/

明示的には、

<https://example.com/>

と書けます。

19. メールアドレス

<example@example.com>

20. 画像

![代替テキスト](画像URL)

例：

![Excelロゴ](images/excel.png)

リンク：

[文字](URL)

画像：

![文字](URL)

21. 水平線

---

または、

***

22. 表

| 名前 | 種類 | 用途 |

|---|---|---|

| Excel | 表計算 | データ処理 |

| Power Query | ETL | データ加工 |

| VBA | 言語 | 自動化 |

23. 表の位置揃え

| 左寄せ | 中央 | 右寄せ |

|:---|:---:|---:|

| A | B | 100 |

| C | D | 200 |

意味：

:---     左寄せ

:---:    中央寄せ

---:     右寄せ

24. エスケープ

Markdownの記号を、そのまま文字として表示したい場合は \ を使います。

\*これは斜体にならない\*

代表例：

\#

\*

\_

\-

\+

\`

\[

\]

25. HTML

Markdown環境によってはHTMLを直接記述できます。

<br>

<strong>太字</strong>

ただし、HTMLを禁止しているMarkdown処理系もあります。

26. 折りたたみ

GitHubなど、HTMLを許可する環境では次のようにできます。

<details>

<summary>詳細を見る</summary>

ここに詳細を書きます。

</details>

27. 脚注

一部のMarkdown処理系で使用できます。

Markdownは軽量マークアップ言語です。[^1]

[^1]: John Gruberによって作られました。

28. リンクを別定義する

本文：

[OpenAI][openai]

別の場所：

[openai]: https://openai.com/

29. 見出しへのリンク

## Power Queryの概要

に対して、

[Power Queryの概要](#power-queryの概要)

のようにリンクできます。

アンカー生成規則はMarkdown処理系によって異なります。

30. 数式

MathJaxやKaTeX対応環境では数式を書けます。

インライン：

$E = mc^2$

独立した数式：

$$

E = mc^2

$$

31. コメント

<!-- この部分は通常表示されません -->

32. 特殊文字

#  見出し

*  強調・箇条書き

_  強調

-  箇条書き・水平線

+  箇条書き

>  引用

`  コード

[  リンク

]  リンク

!  画像

|  表

\  エスケープ

33. よく使う記法だけ抜き出すと

# 見出し1

## 見出し2

### 見出し3

**太字**

*斜体*

~~取り消し~~

- 箇条書き

- 箇条書き

1. 番号

2. 番号

- [ ] 未完了

- [x] 完了

> 引用

`コード`

[リンク](https://example.com/)

![画像](image.png)

---

| 項目 | 内容 |

|---|---|

| A | 100 |

| B | 200 |

34. 技術文書で特によく使う組み合わせ

# Power Query入門

## 概要

Power Queryは、Excelなどで使用できるデータ取得・変換機能です。

## 基本構文

```powerquery

let

    Source = Excel.CurrentWorkbook()

in

    Source

```

## ポイント

- `let` で式を定義する

- `in` で最終的な値を返す

- 各ステップは値として扱われる

> ポイント

> Power QueryのM言語は関数型言語です。

## 関連項目

- [Microsoft Learn](https://learn.microsoft.com/)

35. Markdownで混同しやすいもの

書き方	意味
# text	見出し
> text	引用
- text	箇条書き
` text `	インラインコード
text	太字
text	斜体
[text](url)	リンク
![text](url)	画像
---	水平線
\*	記号としての *

36. Markdownには「方言」がある

記法	基本Markdown	GitHub系
見出し	○	○
太字	○	○
斜体	○	○
リンク	○	○
画像	○	○
引用	○	○
コード	○	○
表	△	○
取り消し線	△	○
チェックリスト	×	○
脚注	処理系依存	処理系依存
数式	×	処理系依存

現在実務でよく使われるのは、基本Markdownに表・取り消し線・チェックリストなどを追加した GitHub Flavored Markdown（GFM）系です。

37. 最小チートシート

#             見出し1

##            見出し2

###           見出し3

**文字**      太字

*文字*        斜体

~~文字~~      取り消し線

-             箇条書き

1.            番号付きリスト

- [ ]         チェックボックス

- [x]         完了

>             引用

`文字`        インラインコード

[文字](URL)   リンク

![文字](URL)  画像

---           水平線

| A | B |     表

|---|---|

\             エスケープ

出典メモ

本記事は、ほえほえ作成のMarkdown記法整理原稿をもとに再構成しました。Markdownには処理系ごとの方言があり、取り消し線、チェックリスト、脚注、数式、HTML、折りたたみなどは利用環境によって対応状況が異なります。公開先の仕様を併せて確認してください。

参考: CommonMark Spec（https://spec.commonmark.org/spec）、GitHub Docs: Basic writing and formatting syntax（https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax）