Remark 结构
从您的文档中提取信息，有助于实现文档搜索
用法
将其添加为 remark 插件。
import { compile } from '@mdx-js/mdx';
import { remarkStructure } from 'fumadocs-core/mdx-plugins';
const vfile = await compile('...', {
remarkPlugins: [remarkStructure],
});此插件默认包含在 Fumadocs MDX 中。
提取的信息可以在 vfile.data.structuredData 中找到，您可以编写自己的插件将其转换为 MDX 导出。
选项
Prop
Type
输出
标题和内容的列表。段落将被提取到 contents 数组中，每个项目包含一个 heading 属性，表示段落的标题。
注意
一个标题可以有多个段落。
标题
| 属性 | |
|---|---|
id | 标题的唯一标识符或 slug |
content | 文本内容 |
内容
| 属性 | |
|---|---|
heading | 段落的标题（可为空） |
content | 文本内容 |
作为函数
接受 MDX/markdown 内容并返回结构化数据。
import { structure } from 'fumadocs-core/mdx-plugins';
structure(page.body.raw);提示
如果您启用了自定义 remark 插件，例如
remark-math，则必须将这些插件传递给该函数。这可以避免段落中出现不可读的内容。
import { structure } from 'fumadocs-core/mdx-plugins';
import remarkMath from 'remark-math';
structure(page.body.raw, [remarkMath]);参数
| 参数 | |
|---|---|
content | MDX/markdown 内容 |
remarkPlugins | remark 插件列表 |
options | 自定义选项 |
How is this guide?
Last updated on