1. MDN Web Docs
  2. 執筆ガイドライン
  3. 手引き
  4. Markdown の書き方

このページはコミュニティーの尽力で英語から翻訳されました。MDN Web Docs コミュニティーについてもっと知り、仲間になるにはこちらから。

View in English Always switch to English

Markdown の書き方

このページでは、MDN Web Docs のドキュメントを Markdown で書く方法を説明します。 ベースラインとして GitHub-Flavored Markdown (GFM) を選択し、MDN で必要な機能を実現するために拡張機能を追加しています。

ベースライン: GitHub-Flavored Markdown

MDN Markdown のベースラインは GitHub-Flavored Markdown (GFM、 https://github.github.com/gfm/) です。つまり、このページで明示的に指定していない仕様については、 GFM 仕様を参照してください。 GFM は CommonMark (https://spec.commonmark.org/) の上位互換です。

リンク

GFM 仕様書では、基本的に 2 種類のリンクを定義しています。

MDN では、インラインリンクのほうが文脈を失わず読みやすく、保守しやすいため、こちらを推奨しています。MDN でリンクを書く際は、次の形式を使用してください。

md
[マカロン](https://en.wikipedia.org/wiki/Macaron) はおいしいものの、作るのは難しいお菓子です。

ただし、場合によっては、簡潔に書けるリファレンスリンクのほうが適しています。 例えば、横幅の広い表は、リファレンスリンクを使うと確認や編集がしやすくなります。

md
| 名前                     | 特徴                                                           |
| ------------------------ | -------------------------------------------------------------- |
| [マカロン][macarons]     | おいしいものの、作るのは難しい。お茶会に華を添えるお菓子です。 |
| [ビスコッティ][biscotti] | 歯ごたえがあり、作るのも簡単です。                             |

[macarons]: https://en.wikipedia.org/wiki/Macaron
[biscotti]: https://en.wikipedia.org/wiki/Biscotti

リファレンスリンクを使う必要がある場合は、使用箇所のすぐ後にリンク先を定義してください。

コードブロックの例

GFM や CommonMark では、「コードフェンス」を使用して <pre> ブロックを区切ることができます。冒頭のコードフェンスの後には、「情報文字列」と呼ばれるテキストが続くことがあります。コードサンプルの言語は情報文字列の最初の単語で指定する必要があり、ブロックの構文強調表示に使用されます。次の単語に対応しています。

  • プログラミング言語
    • JavaScript
      • js - JavaScript
      • ts - TypeScript
      • jsx - React JSX
      • tsx - React TSX
    • C-like
      • c - C
      • cpp - C++
      • cs - C#
      • java - Java
    • Other
      • python - Python
      • php - PHP
      • rust - Rust
      • glsl - GLSL (OpenGL シェーダー)
      • sql - SeQueL コマンド
      • wat - WebAssembly
      • webidl - Web Interface Definition Language
  • スタイル設定
    • css - CSS
    • scss - Sass (SCSS)
    • less - Less
  • マークアップ
    • html - HTML
    • svg - SVG
    • xml - XML
    • mathml - MathML
    • md - Markdown
    • latex - LaTeX
  • コマンドプロンプト
    • bash - Bash/Shell
    • batch - Batch (Windows Shell)
    • powershell - PowerShell
  • 設定/データファイル
    • json - JSON
    • ini - INI
    • yaml - YAML
    • toml - TOML
    • sql - SQL データベース
    • ignore - Gitignore ファイル
    • apacheconf - Apache 設定ファイル
    • nginx - NGINX 設定ファイル
  • テンプレート
    • django - Django テンプレート
    • svelte - Svelte テンプレート
    • hbs - Handlebars テンプレート
    • pug - Pug テンプレート （Express で使用される可能性がある）
  • その他
    • plain - プレーンテキスト
    • diff - 差分ファイル
    • http - HTTP ヘッダー
    • regex - 正規表現
    • uri - URI および URL

例えば、次のようにします。

md
```js
const greeting = "I will get JavaScript syntax highlighting";
```

使用したいハイライトが上記に掲載されていない場合は、コードブロックを plain としてマークアップしてください。 GitHub での議論の過程で、追加の言語がリクエストされることがあります。

メモ: 言語識別子は、上記の一覧にあるものを正確に使用してください。例えば、javascript は使用できないため、js と記述してください。

リンターの抑制

書き手はどの言語識別子にも、接尾辞 -nolint を追加することができます。

md
```html-nolint
<p>
I will not be linted.
</p>
```

このようなコードブロックは適切な構文強調表示が行われ、ライブサンプルシステムで認識されますが、リンターや Prettier のような自動フォーマッターでは無視されます。この接尾辞は、リンターや書式化ツールに修正させたくない不正なコードや代替書式を表示するために使用してください。

追加クラス（情報文字列）

GFM では情報文字列に対応しており、コードブロックに関する追加情報を記述することができます。 MDN では、情報文字列はクラス名に変換されます。

書き手は以下の追加の単語のいずれかを使用することができますが、これらの単語は言語の単語の後に置く必要があります。

  • example-good: この例を良い例 (採用すべきもの) としてスタイル付けする
  • example-bad: この例を悪い例 (避けるべきもの) としてスタイル付けする
  • hidden: このコードブロックをページに表示しません。これはライブサンプルで使用するためのものです。

例:

md
```js example-good
const greeting = "I'm a good example";
```

```js example-bad
const greeting = "I'm a bad example";
```

```js hidden
const greeting = "I'm a secret greeting";
```

これらは以下のように表示されます。

js
const greeting = "I'm a good example";
js
const greeting = "I'm a bad example";

議論リファレンス

この課題は次で解決しました。

メモ、警告、コールアウト

執筆者は GFM アラート構文を使用して、コンテンツに特別な注意を促すことができます。アラートには、「メモ」「警告」「コールアウト」の 3 種類があります。

メモ: MDN Web Docs は GFM アラートに対応する前から独自の構文でアラートに対応しており、それらを「ノートブロック」と呼んでいました。 MDN では GFM アラートのうち、 [!TIP], [!CAUTION], [!IMPORTANT] には対応していません。 GFM は [!CALLOUT] には対応していません。

  • メモを追加するには、ブロック引用の最初の行を [!NOTE] にしてください。
  • 警告を追加するには、ブロック引用の最初の行を [!WARNING] にしてください。
  • コールアウトを追加するには、ブロック引用の最初の行を [!CALLOUT] にしてください。

メモと警告は、出力に メモ: または 警告: というテキストが表示されますが、コールアウトは表示されません。このため、コールアウトは、独自のタイトルを提供したい場合に適しています。

複数行は、通常の段落と同じように、空のブロック引用行によって生成されます。さらに、スペースのない複数の行は通常の Markdown の行と同様に扱われ、連結されます。

ブロック引用には、コードブロックやその他のブロック要素を含めることができます。

例

メモ（英語版では Note）

md
> [!NOTE]
> これがメモの書き方です。
>
> 複数行を入れることもできます。

これで次のような HTML が生成されます。

html
<div class="notecard note">
  <p><strong>メモ:</strong> これがメモの書き方です。</p>
  <p>複数行を入れることもできます。</p>
</div>

この HTML は次のように、強調ボックスとして描画されます。

メモ: これがメモの書き方です。

複数行を入れることもできます。

警告（英語版では Warning）

md
> [!WARNING]
> これが警告の書き方です。
>
> 複数の段落を入れることもできます。

これで次のような HTML が生成されます。

html
<div class="notecard warning">
  <p><strong>警告:</strong> これが警告の書き方です。</p>
  <p>複数の段落を入れることもできます。</p>
</div>

この HTML は次のように、強調ボックスとして描画されます。

警告: これが警告の書き方です。

複数の段落を入れることもできます。

コールアウト（英語版では Callout）

md
> [!CALLOUT]
>
> **これがコールアウトの書き方です。**
>
> 複数の段落を入れることもできます。

これで次のような HTML が生成されます。

html
<div class="callout">
  <p><strong>これがコールアウトの書き方です。</strong></p>
  <p>複数の段落を入れることもできます。</p>
</div>

この HTML は次のように、強調ボックスとして描画されます。

これがコールアウトの書き方です。

複数の段落を入れることもできます。

コードブロックを含むメモ

この例はコードブロックを含んでいます。

md
> [!NOTE]
> これがメモの書き方です。
>
> コードブロックを含むことができます。
>
> ```js
> const s = "コードブロックの中です";
> ```
>
> こんな感じです。

これで次のような HTML が生成されます。

html
<div class="notecard note">
  <p><strong>メモ:</strong> これがメモの書き方です。</p>
  <p>コードブロックを含むことができます。</p>
  <pre class="brush: js">const s = "コードブロックの中です";</pre>
  <p>こんな感じです。</p>
</div>

この HTML は次のようにコードブロックと一緒に描画されます。

メモ: これがメモの書き方です。

コードブロックを含むことができます。

js
const s = "コードブロックの中です";

こんな感じです。

議論リファレンス

この課題は https://github.com/mdn/content/issues/3483 で解決されました。

定義リスト

定義リストは MDN では一般的に使用されていますが、 GFM では対応していません。 MDN では定義リスト用に独自の形式を導入しており、これは GFM の順序なしリスト (<ul>) を変形した形式です。この形式では、

  • GFM <ul> は任意の数の最上位の GFM <li> 要素を含みます。
  • 最上位の GFM <li> 要素は、最後の要素として GFM <ul> 要素を含みます。
  • 最終的に含まれる <ul> は、単一の GFM <li> 要素を含み、この中身は ": " (コロンに続いて空白) で始まるテキストでなければなりません。この要素はブロック要素、例えば段落、コードブロック、埋め込みリスト、メモなどを含むことができます。

最上位の GFM <li> 要素は、次のように <dt>/<dd> の組に変換されます。

  • 最上位の GFM <li> 要素は、GFM <li> 要素として解析され、その内部コンテンツは、 <dt> の内容を構成しますが、最後に入れ子になった <ul> については例外で、 <dt> には含まれません。
  • 最後に入れ子になった <ul> の中の <li> 要素は、GFM <li> 要素として解析され、その内容は <dd> の内容を構成しますが、先頭の : は捨てられます。

例えば、これは <dl> です。

md
- term1
  - : My description of term1
- `term2`
  - : My description of term2

    複数の段落やコードブロックを格納することもできます。

    ```js
    const thing = 1;
    ```

GFM/CommonMark では、これは次の HTML を生成します。

html
<ul>
  <li>
    <p>term1</p>
    <ul>
      <li>: My description of term1</li>
    </ul>
  </li>
  <li>
    <p><code>term2</code></p>
    <ul>
      <li>
        <p>: My description of term2</p>
        <p>複数の段落やコードブロックを含めることもできます。</p>
        <pre>
          <code class="brush: js">const thing = 1;</code>
        </pre>
      </li>
    </ul>
  </li>
</ul>

MDN では、これは次の HTML を生成します。

html
<dl>
  <dt>
    <p>term1</p>
  </dt>
  <dd>My description of term1</dd>
  <dt>
    <p><code>term2</code></p>
  </dt>
  <dd>
    <p>My description of term2</p>
    <p>複数の段落やコードブロックを含めることもできます。</p>
    <pre>
       <code class="brush: js">const thing = 1;</code>
    </pre>
  </dd>
</dl>

この構文で書かれた定義リストは、 <dt>/<dd> 要素のペアで構成されます。この構文では、 2 つ以上の連続した <dt> 要素、または 2 つ以上の連続した <dd> 要素を持つリストを書くことはできません。パーサーはこれをエラーとして扱います。 MDN 上のほとんどすべての定義リストがこの制限で動作することを期待しており、動作しないものについては、生の HTML に戻ることができます。

以下のものは許可されていません。

md
- `param1`, `param2`, `param3`
  - : My description of `param1`
  - : My description of `param2`
  - : My description of `param3`

複数の <dt> 項目を 1 つの <dd> に関連付ける必要がある場合の回避策として、以下のように複数の用語をカンマで区切って 1 つの <dt> として提供することを検討してください。

md
- `param1`, `param2`, `param3`
  - : My description of params 1, 2, and 3

ここで説明する構文の根拠は、 CommonMark を期待するツール (Prettier や GitHub のプレビューなど) で十分に機能すると同時に、記述と解析が適度に簡単であることです。

議論リファレンス

この課題は https://github.com/mdn/content/issues/4367 で解決されました。

表

GFM は表を作成する構文を提供しており、 MDN ではそれを使用しています。しかし、 GFM の表が私たちのニーズに合わない場合もあります。

  • GFM の構文は HTML で利用可能な機能の一部しか対応していません。 GFM で対応していない表の機能を使う必要がある場合は、表を表現するのに HTML を使用してください。
  • GFM による表の表現が幅 150 文字を超える場合は、 HTML の表を使用してください。
  • 「プロパティ表」と呼ばれる特殊な種類の表があり、独自の CSS クラスがあります。その場合は常に HTML を使用してください。

ですから、ここでの一般的な原則は、可能な限り GFM Markdown の構文を使用しますが、 HTML を使用する必要がある場合、その方が読みやすい場合は生の HTML に立ち戻ってください。下記の HTML 表を使用する場合を参照してください。

GFM の表の構文

GFM の表構文では、行の先頭と末尾のパイプを省略できます。しかし、 MDN では読み取り可能なように、これらのパイプを記載しなければなりません。また、行の末尾に空間を提供し、段組みのセルがすべて同じ長さになるようにしなければなりません。

つまり、 MDN の編集者はこのスタイルを使用する必要があります。

md
| Heading 1 | Heading 2 | Heading 3 |
| --------- | --------- | --------- |
| cell 1    | cell 2    | cell 3    |
| cell 4    | cell 5    | cell 6    |

このスタイルではありません。

md
| Heading 1 | Heading 2 | Heading 3 |
| --------- | --- |----------------------|
| cell 1 | cell 2 | cell 3 |
cell 4 | cell 5 | cell 6

表は Prettier によって整形されるため、書き手はツールを使って適切に整形できます。

HTML 表を使用する場合

書き手が GFM 構文ではなく HTML 表を使用すべき主な状況は 3 つあります。

  1. 表は GFM では対応していない機能（下記参照）を使用する場合。
  2. GFM の表の幅が広すぎて読みにくい場合。
  3. 書き手が「プロパティテーブル」と呼ばれる特殊な表を使いたい場合。

GFM が対応していない表機能

GFM 表構文の主な制限事項は以下の通りです。

  • GFM の表ではヘッダー行が必要です。
  • GFM の表ではヘッダー列を設定することができません。
  • GFM は表のセル内にある GFM ブロック要素を解析しません。例えば、表のセル内にリストを入れることはできません。
  • GFM の表にはクラスを割り当てることはできません。
  • GFM は <table>, <tr>, <th>, <td> 以外の表要素に対応していません。
  • GFM は colspan, rowspan, scope のような表要素の属性に対応していません。

もし、対応していない機能を使う必要がある場合は、 HTML で表を作成する必要があります。

なお、表に <caption> 要素を使うことは、 GFM 構文からも排除されるため、一般的にはお勧めしません。

GFM 表の最大幅

GFM では、表を「ASCII アート」で表現しているため、表が長くなると読みづらくなります。たとえば、次のような表があるとします。

html
<table>
  <thead>
    <tr>
      <th>見出し 1</th>
      <th>見出し 2</th>
      <th>見出し 3</th>
      <th>見出し 4</th>
      <th>見出し 5</th>
      <th>見出し 6</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td>短めのもの</td>
      <td>
        GFM の書式では表組みが崩れてしまうほど、何かについて本当に詳しく書かれている長いもの。
      </td>
      <td>短めのもの</td>
      <td>
        また、何かについて実に詳しく書かれている、大量のテキストを含むセルは、GFM の書式では表の書式が崩れ始めてしまいます。
      </td>
      <td>短めのもの</td>
      <td>短めのもの</td>
    </tr>
  </tbody>
</table>

GFM ではこのようになります。

md
| 見出し 1   | 見出し 2                                                                               | 見出し 3   | 見出し 4                                                                                                              | 見出し 5   | 見出し 6   |
| ---------- | -------------------------------------------------------------------------------------- | ---------- | --------------------------------------------------------------------------------------------------------------------- | ---------- | ---------- |
| 短めのもの | GFM の書式では表組みが崩れてしまうほど、何かについて本当に詳しく書かれている長いもの。 | 短めのもの | また、何かについて実に詳しく書かれている、大量のテキストを含むセルは、 GFM の書式では表の書式が崩れ始めてしまいます。 | 短めのもの | 短めのもの |

このような場合は、HTML を使用するのがよいでしょう。

これにより導かれるガイドラインは、表の Markdown 表現が幅 150 文字以上になる場合、その表には HTML を使用することです。

プロパティ表

プロパティ表は特定の種類の表で、特定の型のページ同士でまたがって使用される、構造化されたプロパティ値を表示するために使用されるものです。これらの表には 2 つの列があります。最初の列はヘッダー列で、プロパティを列挙し、2 番目の列にはこの特定の項目に関する値を列挙します。例えば、以下は PannerNode インターフェイスのプロパティ表です。

入力数 1
出力数 0
チャンネルの数え方 "explicit"
チャンネル数 2
チャンネルの意味 "speakers"

これらのページはヘッダー列があるため、 GFM では表せませんので、この場合は HTML を使用しましょう。 特殊なスタイルにするには、 "properties" クラスを表に適用する必要があります。

html
<table class="properties"></table>

議論リファレンス

この課題は https://github.com/mdn/content/issues/4325, https://github.com/mdn/content/issues/7342, https://github.com/mdn/content/issues/7898#issuecomment-913265900 で解決しました。

上付き・下付き文字

HTML の <sup> および <sub> 要素を必要に応じて使用することができますが、可能な限り代替策を採ってください。具体的には次のようにします。

  • べき乗については、 2^53 のようにキャレットを使用してください。
  • 1st のような序数表現では、 "first" のように言葉を使用してください。
  • 脚注については、脚注参照を <sup>[1]</sup> のようにマークアップしないでください。必要ありません。

議論リファレンス

この課題は https://github.com/mdn/content/issues/4578 で解決しました。

ページ概要

ページ概要はページの最初の「コンテンツ」の段落で、ページのフロントマターやサイドバーやページバナーマクロの後に現れる最初のテキストです。

この概要は検索エンジン最適化 (SEO) のために使用され、また、マクロによってはページリストに自動的に含まれます。 したがって、最初の段落は、簡潔で説明的なものでなければなりません。

議論リファレンス

この課題は https://github.com/mdn/content/issues/3923 で解決しました。

マクロ

文章には、共通のリンクパターンをテンプレート化したり、特定のコードやテキストのブロックを含めたりするために、マクロを使用します。

md
**`margin`** [CSS](/ja/docs/Web/CSS) プロパティは、要素の 4 辺すべてのマージン領域を設定します。
これは {{cssxref("margin-top")}}、{{cssxref("margin-right")}}、{{cssxref("margin-bottom")}}、{{cssxref("margin-left")}} の一括指定です。
…

詳しくはマクロの使用を参照してください。

MDN の改良に協力

協力方法を知る

このページは に MDN の貢献者によって最終更新されました。

GitHub でこのページを表示 • このコンテンツに関する問題を報告