toMedia
框架集成

Vite

Fumadocs MDX 的 Vite 集成指南

安装

npm i fumadocs-mdx fumadocs-core @types/mdx

配置

source.config.ts

source.config.ts
import { defineDocs } from 'fumadocs-mdx/config';

export const docs = defineDocs({
  dir: 'content/docs',
});

vite.config.ts

vite.config.ts
import { defineConfig } from 'vite';
import mdx from 'fumadocs-mdx/vite';
import * as MdxConfig from './source.config';

export default defineConfig({
  plugins: [mdx(MdxConfig)],
});

导入别名(可选)

tsconfig.json 中配置 TypeScript 路径映射:

{
  "compilerOptions": {
    "paths": {
      "collections/*": [".source/*"]
    }
  }
}

Fumadocs 集成

创建 app/lib/source.ts 连接 Fumadocs:

app/lib/source.ts
import { docs } from 'collections/server';
import { loader } from 'fumadocs-core/source';

export const source = loader({
  baseUrl: '/docs',
  source: docs.toFumadocsSource(),
});

.source 文件夹会在开发或生产构建时自动生成。内容文件放在 content/docs 目录中。

On this page