Command Palette

Search for a command to run...

MA

Markdown TOC Generator

Markdownの見出しからリンクされた目次を生成します

Markdown Table of Contents Generatorとは?

Markdown 目次ジェネレーターは、Markdown ドキュメントの見出しを読み取り、各セクションにジャンプするリンクのネストされたリストを作成します。 Markdown を貼り付けると、ツールは、すべての行が `[Heading](#anchor)` リンクである箇条書きリストなどのすぐに使用できるブロックを返します。これにより、アウトラインを手書きで作成したり、レンダラーが各見出しに割り当てるアンカー ID を推測したりすることができなくなります。

ツールのハートはアンカー slug です。 GitHub、GitLab、およびほとんどの static-site ジェネレーターは、テキストを小文字にしたり、句読点を削除したり、スペースをハイフンに置き換えたりすることで、「開始」のような見出しを id `getting-started` に変換します。このジェネレーターは、GitHub が 2 つの見出しが slug を共有するときに追加する数値接尾辞 (`-1`、`-2`) を含む同じルールを適用します。そのため、README または docs ページがレンダリングする正確な id に resolve を生成するリンクは、ATX 見出し (`#` で始まる行) と Setext 見出し (`=` または `-` で下線付きのテキスト) の両方を読み取り、フェンスで囲まれたコード ブロック内に表示される任意の `#` を無視します。インライン書式設定を含む見出しは、同じ方法で処理されます。リンク、太字のテキスト、インライン コード、または見出し内の画像は、ラベルのプレーン テキストに縮小され、アンカーは、同じクリーニングされた文字列から構築されるため、常に 2 つが一致します。

すべてがブラウザで実行されます 貼り付けたMarkdownはクライアント側のJavaScriptで解析され、デバイスから離れることがないため、アップロードもアカウントもコンテンツの追跡もありません。ツールはページがロードされるとオフラインで動作し、含める見出しレベルを選択し、箇条書きリストと番号付きリストを切り替えてインデントを制御でき、オプションを変更した瞬間にアウトラインを更新します。

Markdown TOC Generatorの使い方は?

  1. マークダウンを貼り付けます

    Markdown の完全なドキュメントまたは README を入力ボックスにドロップします。フェンスで囲まれたコード ブロック内の見出しは自動的にスキップされます。

  2. 見出しレベルを選択します

    最も浅いレベルと最も深いレベルを設定して含めます。一般的な選択肢は H2 から H3 で、すべてのサブセクションをリストせずにアウトラインを読みやすくします。

  3. リストスタイルを選択します

    箇条書きまたは番号付きのリストを切り替え、アンカー リンクのオンとオフを切り替えて、2 スペース、4 スペース、またはタブのインデントを選択します。

  4. 目次をコピー

    生成された Markdown をコピーして、ドキュメントの上部近くに貼り付けます。各エントリは、一致する見出しアンカーにリンクします。

主な機能

  • GitHub 互換アンカー

    Slugs は、重複する見出しの数字接尾辞を含む、ids GitHub レンダリングと一致するため、すべてのリンクが正しく解決されます。

  • レベルフィルタリング

    必要な見出しレベルのみを含めます。ネストすると、最も浅い含まれる見出しから測定されるため、H2 から始まるリストは左側にフラッシュされたままになります。

  • 順序付けされているか、順序付けされていません

    オプションのアンカー リンクと構成可能なインデントを使用して、レベルごとのカウンターを備えた箇条書きリストまたは番号付きリストを出力します。

  • コードブロックを認識します

    フェンスで囲まれたコード ブロック内に書かれた見出しは無視されるため、スニペットの例がアウトラインに漏れることはありません。

Frequently Asked Questions

Markdown 目次は、同じページ内の見出しアンカーを指すリンクのリストです。 Markdown ドキュメントの各見出しには自動 ID が与えられ、[セクション] (#セクション) と書かれたリンクがそれにジャンプします。このツールは、見出しを読み取り、一致するアンカーを構築し、ネストされたリストを組み立てます。

Comments

0 comments

0/2000 characters

No comments yet. Be the first to share your thoughts!

markdown table of contentsmarkdown toc generatorgenerate tocmarkdown toctable of contents generatorgithub anchor linksreadme tocheading linksmarkdown outline