Markdown 目次ジェネレーター

どの Markdown ドキュメントにも、クリックできる入れ子の目次を作れます。

ブラウザ内で動作
アップロード不要
アカウント不要

ブラウザツールを読み込んでいます…

Markdown 目次ジェネレーターでできること

長い README、SOP、管理者ガイドには冒頭近くに目次が必要ですが、手で同期させ続けると間違いが起きがちです。ドキュメント全体を貼り付けると、=== や --- の下線で書いた見出しを含むすべての見出しを読み取り、各セクションに移動できるリンクの入れ子のリストを書き出します。

どこまで深く含めるかは「含める階層」で、H2 だけからすべての階層まで選べます。単独の H1 タイトルは、たいていドキュメント自体の名前なので、既定で除かれます。「番号付きの目次」をオンにすると 1.、2.、3. のアウトラインになり、ドキュメントを再構成するときの簡単な見出しマップとしても使えます。

例

入力

# レコーダーハンドブック

## 録画の前に
### マイクチェック (2 分)
## 編集
### 間をカットする
## 編集
#### キーボードショートカット

結果

- [録画の前に](#録画の前に)
  - [マイクチェック (2 分)](#マイクチェック-2-分)
- [編集](#編集)
  - [間をカットする](#間をカットする)
- [編集](#編集-1)

H1 のタイトルは除かれ、H4 は既定の H3 より深いので入らず、アンカーから括弧が消え、2 つ目の「編集」の見出しは #編集-1 にリンクします。

Markdown 目次ジェネレーターの使い方

Markdown ドキュメント全体を貼り付けるか、「ファイルを開く」で .md ファイルを読み込みます。
「含める階層」でレベルを選びます。「その他のオプション」には「単独の H1 タイトルを除く」と「番号付きの目次」があります。
「コピー」または「.md をダウンロード」をクリックし、ドキュメントのタイトルの下にリストを貼り付けます。

知っておきたいこと

GitLab、Bitbucket、Docusaurus などの表示環境では、句読点やラテン文字以外を含む見出しの id の作り方が GitHub と異なる場合があるので、そこでいくつかのリンクを試してください。
フェンスコード内の見出しは当然無視されますが、<h2> のような生の HTML で書いた見出しも拾われません。
リストはその時点のスナップショットです。見出しの名前を変えたり追加したりしたら、もう一度生成してください。自動では更新されません。

Markdown 目次ジェネレーターについてよくある質問

GitHub の README に目次を追加するには？

README をここに貼り付け、生成されたリストをコピーして、タイトルの下に貼り付けます。各項目は、GitHub がその見出しに作るアンカーにリンクします。GitHub には README 用のアウトラインメニューもありますが、ファイル内のリストならどの閲覧環境でも機能します。

目次のリンクが見出しに移動しないのはなぜですか？

たいていは、リストを作った後で見出しが変わったか、サイトのアンカーの作り方が GitHub と違うためです。現在のテキストからリストを作り直し、1 つのアンカーを、サイトがその見出しに実際に付けている id と比べてください。

目次に H4 の見出しを含めるべきですか？

通常は含めません。読み手が拾い読みするのは H2 のセクションで、長いガイドなら H3 で十分な詳しさになります。それより深くすると、リストが要約する内容より長くなってしまうので、既定の H3 のままにし、H4 や「すべて」はリファレンスドキュメントでだけ選んでください。

目次に番号を付けられますか？

はい。「その他のオプション」で「番号付きの目次」をオンにします。各階層は 1 から番号が振られ、スペース 3 つでインデントされるので、入れ子の番号付きリストとして表示されます。