Markdown文書に目次を追加する

長いREADMEにはナビゲーションが必要です。GitHub式アンカーの入れ子目次を生成し、見出し変更に合わせて更新します。

このガイドで使う道具

やりたいこと

READMEはスクロールで読める範囲を超えて育ちます。冒頭のリンク付き目次で読者の見通しを保ちますが、手書きの目次は見出し改名と同時に腐ります。

生成方法

文書を貼り、見出し範囲を選び（READMEならH2〜H4が典型）、実行します。フェンスコード内の見出しを除いて抽出し、GitHub式アンカー（小文字化・空白→ハイフン・記号除去・重複は-1/-2付き）の入れ子リストを出力します。

番号付きオプションは「1.」形式、プレーンはリンクなしアウトラインです。
H1は文書タイトルのことが多いので、目次はH2からが無難です。

具体例

「## Getting Started」「### Docker setup」「## API Reference」がある文書は: - [Getting Started](#getting-started) - [Docker setup](#docker-setup) - [API Reference](#api-reference) を生成します。タイトル下に貼れば、pushした途端にGitHubでリンクが機能します。

対応範囲

アンカーはGitHubのアルゴリズムです。他のレンダラ（GitLab・mdBook）は記号処理が少し違います。30万文字・500見出しまで。見出しを編集したら再生成してください。自動同期はしません。