跳至內容
Fumadocs

Remark Files

從程式碼區塊產生檔案。

簡介

此外掛會將像這樣的程式碼區塊:

```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 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?

最後更新於