TOC Export

ページの目次を `export const toc` 名前付きエクスポートとして出力します。

tocExport 機能はドキュメントの見出しを走査し、処理した各ファイルの先頭に MDX の名前付きエクスポート（export const toc）を挿入します。これによりサイドバーやフローティング TOC コンポーネントに構造化された目次を提供します。

設定

zudoDoc() は標準プリセットに tocExport: {} を含んでいます — デフォルトの maxDepth: 3 に個別の設定フィールドは不要です。（オブジェクト型の機能であり true のショートハンドは受け付けないため、プリセットは常に {} を渡し、true は渡しません。）

import { defineConfig } from "zfb/config";
import { zudoDoc } from "@takazudo/zudo-doc/config";

export default defineConfig(
  zudoDoc({
    siteName: "My Docs",
  }),
);

見出しの深さを制限する場合は、プリセットの markdown.features をスプレッドして tocExport を上書きします — 素の defineConfig({ markdown: { features } }) はプリセットの残りの部分を破棄してしまいます。

const base = zudoDoc({
  // ...your project settings
});

export default defineConfig({
  ...base,
  markdown: {
    ...base.markdown,
    features: {
      ...base.markdown.features,
      tocExport: { maxDepth: 2 },
    },
  },
});

オプション

エクスポートされる構造

この機能は、エントリが次の型に従う export const toc を挿入します。

type TocEntry = {
  depth: number; // absolute heading depth: 2 | 3 | 4 | 5 | 6
  id: string; // slug assigned by the heading-links pass
  text: string; // plain-text heading content (hash-link stripped)
  children: TocEntry[]; // nested sub-headings within maxDepth
};

出力例

h2 と h3 の見出しを持つドキュメントの場合、挿入されるエクスポートは次のようになります。

export const toc = [
  {
    depth: 2,
    id: "introduction",
    text: "Introduction",
    children: [{ depth: 3, id: "introduction-background", text: "Background", children: [] }],
  },
  { depth: 2, id: "conclusion", text: "Conclusion", children: [] },
];

ネストした id: "introduction-background" は、zudo-doc の階層見出し IDを反映しています。h3 の id には h2 の祖先がプレフィックスされます。

補足

• このエクスポートは見出しリンクパスの後に実行されるため、id スラッグは最終的で重複が解消されており、階層 ID の規約に従います。

• tocExport は Heading Marker TOC とは独立して動作します — 一方を有効化しても他方に干渉しません。

• zudo-doc の既存の TOC アイランドはこのエクスポートで駆動されていません。両者は別々の仕組みです。