Markdownの書き方

執筆・検証: MD Converter編集部

Markdown記法一覧|見出し・表・画像・リンク・改行の書き方

文書作成でよく使うMarkdown記法を、コピーできる例とともに一覧化。HTML・PDFへ変換するときの注意点も解説します。

実務文書で使うMarkdown記法をまとめて確認

Markdownは、記号を使って見出しや箇条書きなどの文書構造を表す書式です。HTMLを直接書くより短く、テキストのままでも内容を読みやすいため、README、仕様書、手順書、議事録などに向いています。

この記事では、文書作成でよく使う記法をコピーできる形でまとめます。実際に使うMarkdownレンダラで表示を確認し、配布時はHTMLまたはPDFへ変換してください。

見出し

行頭の#の数で見出しの階層を表します。通常は文書タイトルを#、章を##、章内の項目を###にします。

# 文書タイトル
## 1. 概要
### 1.1 対象読者

文字を大きくする目的だけで見出しを使わず、内容の親子関係に合わせることが大切です。#の次に###を置くような階層の飛び越しを避けると、目次やアクセシビリティも整います。

段落と改行

段落を分けるときは、文章の間に空行を入れます。同じ段落内で強制的に改行する場合は、行末に半角スペースを2つ入れるか、対応環境ではバックスラッシュを置きます。

これは1つ目の段落です。

これは2つ目の段落です。

同じ段落の1行目です。  
2行目に改行されます。

Enterを1回押しただけでは改行されない実装もあります。詳しくはMarkdownで改行されない原因を確認してください。

太字・斜体・取り消し線

**重要な文章**
*補足や強調*
~~削除された内容~~

太字を見出し代わりにすると文書構造が伝わりません。章や項目名には見出しを使い、文中の重要語だけを太字にします。取り消し線はGFMなど対応した環境で利用できます。

箇条書きと番号付きリスト

- 必要な資料を集める
- 内容を確認する
  - 数値を確認する
  - 誤字を確認する

1. Markdownを読み込む
2. プレビューする
3. PDFで保存する

入れ子にするときは、子項目の行頭をスペースで字下げします。インデント幅の解釈は環境によって異なるため、同じ文書内で統一してプレビューを確認します。

リンクと画像

リンクは角括弧に表示名、丸括弧にURLを書きます。画像は先頭に!を追加します。

[公式サイト](https://example.com)

![操作画面の説明](images/screen.png)

画像の角括弧には、画像が見えない場合にも内容が伝わる代替テキストを入れます。相対パスの画像は、HTMLを別の場所へ移動すると参照が切れることがあります。1ファイルで配布したい場合は、画像を埋め込める変換方法が便利です。

列を|、見出しと本文の境界を---で表します。コロンを付けると配置を指定できます。

| 項目 | 状態 | 件数 |
|:---|:---:|---:|
| 設計 | 完了 | 12 |
| 実装 | 進行中 | 8 |

左列は左寄せ、中央列は中央寄せ、右列は右寄せになります。セルへ長文を詰め込むとPDFで横幅を超えやすいため、説明を表の外へ出すか列数を減らします。

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

短いコマンドやファイル名はバッククォート1つで囲みます。複数行のコードはバッククォート3つで囲み、開始位置に言語名を書きます。

`npm run build`

```javascript
const message = "Hello";
console.log(message);
```

長い1行はPDFの右端で切れる場合があります。コード自体を適切に改行するか、折り返し設定を確認してください。

引用・区切り線・チェックリスト

> これは引用文です。

---

- [x] 原稿を確認する
- [ ] PDFを配布する

チェックリストはGFM対応環境で使えます。変換先が対応していない場合は通常の箇条書きとして表示されることがあります。

HTML・PDFにする前の確認

Markdownの対応範囲は変換ツールによって少し異なります。特に表、取り消し線、チェックリスト、HTMLタグ、Mermaidは、利用する処理系で表示を確認してください。また、PDFではページ境界が加わるため、表・画像・コードのはみ出しと改ページも確認が必要です。

まずは基本記法で構造を作り、装飾はプレビューを見ながら最小限に加えると、HTMLでもPDFでも崩れにくい文書になります。

よくある質問

Markdownの方言とは何ですか?
基本記法へ表、チェックリスト、取り消し線などを追加した仕様の違いです。代表例にGFMがあります。配布先が対応する記法を事前に確認してください。

HTMLタグを直接書いてもよいですか?
対応する処理系では使えますが、セキュリティ対策で削除される場合があります。他環境へ持ち出す文書では、まずMarkdown記法を優先します。