Fumadocs

Remark 文件

从代码块生成文件。

介绍

此插件可以将以下代码块转换为:

```files
project
├── src
│   ├── index.js
│   └── utils
│       └── helper.js
├── package.json
```
<Files>
  <Folder name="project" defaultOpen>
    <Folder name="src" defaultOpen>
      <File name="index.js" />
      <Folder name="utils" defaultOpen>
        <File name="helper.js" />
      </Folder>
    </Folder>
    <File name="package.json" />
  </Folder>
</Files>

设置

添加 remark 插件:

source.config.ts
import { remarkMdxFiles } from 'fumadocs-core/mdx-plugins';
import { defineConfig } from 'fumadocs-mdx/config';

export default defineConfig({
  mdxOptions: {
    remarkPlugins: [remarkMdxFiles],
  },
});

并且确保您已定义 <Files /><Folder /><File /> MDX 组件。

How is this guide?

Last updated on

On this page