配置
MDX 选项
Fumadocs MDX 编译器选项配置
MDX 选项用于自定义 MDX 编译器的行为,可以在全局配置或集合级别进行设置。
全局 MDX 选项
在 source.config.ts 中通过 defineConfig 的 mdxOptions 设置:
import { defineConfig } from 'fumadocs-mdx/config';
export default defineConfig({
mdxOptions: {
remarkPlugins: [],
rehypePlugins: [],
},
});常用选项
remarkPlugins
Remark 插件数组,用于处理 Markdown AST。也可以传入函数以追加到默认插件之后:
remarkPlugins: (defaults) => [...defaults, myPlugin],rehypePlugins
Rehype 插件数组,用于处理 HTML AST。同样支持函数形式:
rehypePlugins: (defaults) => [myPlugin, ...defaults],providerImportSource
指定 MDX 组件提供者的导入路径:
mdxOptions: {
providerImportSource: '@/components/mdx',
},集合级别覆盖
每个集合可以单独覆盖全局 MDX 选项:
export const docs = defineCollections({
type: 'doc',
dir: 'content/docs',
mdxOptions: {
remarkPlugins: [specialPlugin],
},
});使用 applyMdxPreset() 在集合级别扩展(而非替换)默认预设。
预设模式
- default:包含 Fumadocs 的所有默认 remark/rehype 插件
- minimal:仅接受基本的 MDX 处理器选项,不包含预设插件