{
  "url": "https://unifast.dev/zh-CN/docs/packages/node/toc/",
  "locale": "zh-CN",
  "title": "toc()",
  "description": "创建 TOC 插件，从 Markdown/MDX 中提取标题并填充到 CompileResult.toc。",
  "section": "packages",
  "body": "```ts\n\n```\n\n## 签名\n\n```ts\nfunction toc(options?: TocPluginOptions): UnifastPlugin\n```\n\n## 参数\n\n### options?\n\n目录提取的配置\n\n| 属性 | 类型 | 默认值 | 描述 |\n|----------|------|---------|-------------|\n| `maxDepth` | `number` | `3` | 要包含的最大标题层级（1-6）。值为 3 时会包含 h1、h2 和 h3。 |\n\n## 用法\n\n```ts\n\nconst result = compile(md, {\n  plugins: [\n    toc({\n      maxDepth: 3,\n    }),\n  ],\n});\n\nconsole.log(result.toc);\n// [\n//   { depth: 1, text: \"Introduction\", slug: \"introduction\" },\n//   { depth: 2, text: \"Getting Started\", slug: \"getting-started\" },\n//   { depth: 3, text: \"Installation\", slug: \"installation\" },\n// ]\n```\n\n## 示例\n\n### 基础标题提取\n\n```ts\n\nconst md = `# Introduction\n\n## Getting Started\n\n### Installation\n\n## API Reference\n\n### compile()\n\n### hastToHtml()`;\n\nconst result = compile(md, { plugins: [toc()] });\n\nconsole.log(result.toc);\n// [\n//   { depth: 1, text: \"Introduction\", slug: \"introduction\" },\n//   { depth: 2, text: \"Getting Started\", slug: \"getting-started\" },\n//   { depth: 3, text: \"Installation\", slug: \"installation\" },\n//   { depth: 2, text: \"API Reference\", slug: \"api-reference\" },\n//   { depth: 3, text: \"compile()\", slug: \"compile\" },\n//   { depth: 3, text: \"hastToHtml()\", slug: \"hasttohtml\" },\n// ]\n```\n\n### 限制层级\n\n```ts\n\nconst result = compile(md, {\n  plugins: [toc({ maxDepth: 2 })],\n});\n\nconsole.log(result.toc);\n// Only h1 and h2 headings are included\n// [\n//   { depth: 1, text: \"Introduction\", slug: \"introduction\" },\n//   { depth: 2, text: \"Getting Started\", slug: \"getting-started\" },\n//   { depth: 2, text: \"API Reference\", slug: \"api-reference\" },\n// ]\n```\n\n### 渲染目录导航\n\n```tsx\n\nconst result = compile(md, { plugins: [toc()] });\n\nfunction TableOfContents() {\n  return (\n    <nav>\n      <ul>\n        {result.toc.map((entry) => (\n          <li key={entry.slug} style={{ marginLeft: (entry.depth - 1) * 16 }}>\n            <a href={`#${entry.slug}`}>{entry.text}</a>\n          </li>\n        ))}\n      </ul>\n    </nav>\n  );\n}\n```",
  "alternates": [
    {
      "locale": "en",
      "url": "https://unifast.dev/docs/packages/node/toc/",
      "api": "https://unifast.dev//api/docs/packages/node/toc.json"
    },
    {
      "locale": "ja",
      "url": "https://unifast.dev/ja/docs/packages/node/toc/",
      "api": "https://unifast.dev//api/ja/docs/packages/node/toc.json"
    },
    {
      "locale": "zh-CN",
      "url": "https://unifast.dev/zh-CN/docs/packages/node/toc/",
      "api": "https://unifast.dev//api/zh-CN/docs/packages/node/toc.json"
    },
    {
      "locale": "zh-TW",
      "url": "https://unifast.dev/zh-TW/docs/packages/node/toc/",
      "api": "https://unifast.dev//api/zh-TW/docs/packages/node/toc.json"
    },
    {
      "locale": "ko",
      "url": "https://unifast.dev/ko/docs/packages/node/toc/",
      "api": "https://unifast.dev//api/ko/docs/packages/node/toc.json"
    },
    {
      "locale": "fr",
      "url": "https://unifast.dev/fr/docs/packages/node/toc/",
      "api": "https://unifast.dev//api/fr/docs/packages/node/toc.json"
    },
    {
      "locale": "it",
      "url": "https://unifast.dev/it/docs/packages/node/toc/",
      "api": "https://unifast.dev//api/it/docs/packages/node/toc.json"
    },
    {
      "locale": "es",
      "url": "https://unifast.dev/es/docs/packages/node/toc/",
      "api": "https://unifast.dev//api/es/docs/packages/node/toc.json"
    },
    {
      "locale": "pt-BR",
      "url": "https://unifast.dev/pt-BR/docs/packages/node/toc/",
      "api": "https://unifast.dev//api/pt-BR/docs/packages/node/toc.json"
    },
    {
      "locale": "de",
      "url": "https://unifast.dev/de/docs/packages/node/toc/",
      "api": "https://unifast.dev//api/de/docs/packages/node/toc.json"
    },
    {
      "locale": "ru",
      "url": "https://unifast.dev/ru/docs/packages/node/toc/",
      "api": "https://unifast.dev//api/ru/docs/packages/node/toc.json"
    },
    {
      "locale": "hi",
      "url": "https://unifast.dev/hi/docs/packages/node/toc/",
      "api": "https://unifast.dev//api/hi/docs/packages/node/toc.json"
    },
    {
      "locale": "id",
      "url": "https://unifast.dev/id/docs/packages/node/toc/",
      "api": "https://unifast.dev//api/id/docs/packages/node/toc.json"
    },
    {
      "locale": "tr",
      "url": "https://unifast.dev/tr/docs/packages/node/toc/",
      "api": "https://unifast.dev//api/tr/docs/packages/node/toc.json"
    },
    {
      "locale": "vi",
      "url": "https://unifast.dev/vi/docs/packages/node/toc/",
      "api": "https://unifast.dev//api/vi/docs/packages/node/toc.json"
    }
  ]
}