跳转至主内容
Version: 2.0.0-alpha.73

内联目录

每个 Markdown 文档会在右上角显示一个目录栏。

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

完整目录#

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

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

自定义目录#

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

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

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

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

注意

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

示例章节 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