Markdown 目次ジェネレーター
Markdown文書の目次を生成します。READMEまたはドキュメントページを貼り付け、含める見出しレベルを選ぶと、GitHubが見出しIDを作成する方式に沿って、各見出しのアンカーへのリンクを含む階層リストが生成されます。コードブロック内の見出しは除外され、重複した見出しには番号付きのアンカーが付けられます。
よくある質問
アンカーリンクはどのように作成されますか?
GitHubが見出しIDを作成するのと同じ方式です。見出しのテキストを小文字にし、句読点と記号を削除して、スペースをハイフンに置き換えます。Getting Startedは#getting-startedになり、C++ & Rustは#c--rustになります。
同じ見出しが複数回出てくるとどうなりますか?
GitHubと同様に、同じテキストの2つ目の見出しではアンカーに-1が追加され、3つ目では-2が追加されます。これにより、すべてのリンクが正しいセクションを指します。
どの見出しが認識されますか?
先頭に#が1〜6個あるATX見出しと、=または-で下線を付けたsetext見出しです。フェンス付きコードブロック、インデントされたコード、YAMLフロントマター内の見出しは無視されます。
見出し内の書式はどのように扱われますか?
リンクはテキストだけを残し、インラインコードはバッククォートを取り除きます。強調記号とHTMLタグは削除され、画像は除外されます。目次の項目テキストとアンカーは、どちらもこのプレーンテキストから作成されます。
どの見出しレベルが含まれますか?
初期設定ではレベル2と3が含まれます。レベル1の見出しは通常、文書のタイトルだからです。最低レベルと最高レベルは1〜6から設定できます。リストのインデントは、見つかった最高レベルの見出しを基準にします。
番号付きリストやプレーンテキストを生成できますか?
はい。番号付きリストを選ぶと、1.、2.のように番号が付き、入れ子の項目にも番号が付けられます。リンクをオフにすると、見出しテキストだけを取得できます。印刷用のアウトラインなどに便利です。