Heading Marker TOC

作成 2026年5月28日更新 2026年6月6日Takeshi Takatsudo

マーカー文字列に一致する見出しの直後に、インラインの目次を挿入します。

Heading Marker TOC 機能は、設定したマーカー文字列に一致する最初の見出しの直後に、ネストされた目次をページ本文へ直接挿入します。フローティングのサイドバー TOC とは異なり、こちらはコンテンツの流れの中にインラインで存在するため、マーカー見出しを置いた場所にちょうど表示されます。

Note

zfb.config.ts の headingMarkerToc キーで有効化します。デフォルト設定なら true、カスタム設定ならオプションオブジェクトを指定します。

// zfb.config.ts export default defineConfig({ markdown: { features: { headingMarkerToc: true, }, }, });

トリガーの仕方

この機能はトリガー方式です。ドキュメント内にマーカーと一致する見出しがない限り、何も出力されません。デフォルトのマーカーは TOC（大文字小文字を区別せずに一致）です。インラインのリストを表示したい場所に、そのテキストの見出しを追加します。

## TOC

すると、何かを置き換えるのではなく、マーカー見出しの直後に、後続のすべての見出し（設定した深さの範囲内）へのリンクからなる <ul>/<li> リストを挿入します。

ライブデモ

以下の ## TOC 見出しがマーカーです。このページにはその後に複数の h2 セクションがあるため、機能はそれらのセクションへのリンクリストをここに挿入します。

背景セクション

最初にリストされるセクションの本文です。

設定オプション

オプションオブジェクトとして渡すと、2 つのオプションを受け付けます。

オプション	デフォルト	説明
`heading`	`"TOC"`	プラグインが探すマーカーテキスト（大文字小文字を区別しない）。
`maxDepth`	`2`	h2 から数えて含める見出しのレベル数（最大 5）。

// zfb.config.ts — カスタムマーカーと深さ
headingMarkerToc: {
  heading: "Contents",
  maxDepth: 3,
},

出力と処理順

生成されるリストは、フラグメント識別子（例: #background-section）を指す <a> タグ付きの <ul>/<li> 要素を出力します。これらの ID は、先に実行される Core の Heading Links パスが作る重複排除済みスラッグです。そのため、アンカーは常にリンク先の見出しと一致します。ID は設定された見出し ID 方式に従います。このサイトは hierarchical を使用しているため、ネストした見出しのアンカーは祖先プレフィックス付きになります（例: #overview-background-section）。

メモ

これは常時有効な Core 機能の Heading Links（見出しにアンカーマーカーを付けるだけ）や、zudo-doc のフローティングサイドバー TOC アイランドとは別物です。Heading Marker TOC は、マーカー見出しによって駆動されるオプトインのインラインリストです。
ページにマーカーと一致する見出しがない場合、この機能は何も出力しません。これは失敗ではなく想定どおりの動作です。

GitHub でソースを見る