内联目录

Each Markdown document displays a tab of content on the top-right corner.

但也可以通过 MDX，直接在 Markdown 文档中显示一个内联目录。

完整目录

toc 变量可以在任何 MDX 文档中使用，并且包含了一个 MDX 文档的所有顶级标题。

import TOCInline from '@theme/TOCInline';
<TOCInline toc={toc} />;

• 完整目录
• 自定义目录
• 示例章节 1
  • 示例段落 1 a
  • 示例段落 1 b
  • 示例段落 1 c
• 示例章节 2
  • 示例段落 2 a
  • 示例段落 2 b
  • 示例段落 2 c
• 示例章节 3
  • 示例段落 3 a
  • 示例段落 3 b
  • 示例段落 3 c

自定义目录

toc 的参数表只是一个目录项的列表：

type TOCItem = {  value: string;  id: string;  children: TOCItem[];};

你可以手动创建这个目录树，也可以从 toc 变量中生成一个新的目录树：

import TOCInline from '@theme/TOCInline';
<TOCInline  toc={    // 只展示第三个和第五个顶层标题    [toc[2], toc[4]]  }/>;

• 示例章节 1
  • 示例段落 1 a
  • 示例段落 1 b
  • 示例段落 1 c
• 示例章节 3
  • 示例段落 3 a
  • 示例段落 3 b
  • 示例段落 3 c

---

caution

下面的内容只是一个示例，为了让当前页面的目录表更丰富一点。

示例章节 1

Lorem ipsum

示例段落 1 a

Lorem ipsum

示例段落 1 b

Lorem ipsum

示例段落 1 c

Lorem ipsum

示例章节 2

Lorem ipsum

示例段落 2 a

Lorem ipsum

示例段落 2 b

Lorem ipsum

示例段落 2 c

Lorem ipsum

示例章节 3

Lorem ipsum

示例段落 3 a

Lorem ipsum

示例段落 3 b

Lorem ipsum

示例段落 3 c

Lorem ipsum