Fumadocs MDX

Fumadocs MDX 是一个将内容转换为类型安全数据的工具，类似于 Content Collections。它不是一个完整的 CMS，而是一个内容处理层，用于处理 Markdown、MDX 文件以及博客文章等内容。

集合（Collections）

集合是特定文件类型的分组，在 source.config.ts 配置文件中定义。Fumadocs MDX 支持三种集合类型：

Doc 集合

将 Markdown 和 MDX 文件转换为 React Server Components，包含目录等属性。

source.config.ts

import { defineCollections } from 'fumadocs-mdx/config';

export const test = defineCollections({
  type: 'doc',
  dir: 'content/docs',
});

Meta 集合

将 YAML 和 JSON 文件处理为数据数组。

source.config.ts

import { defineCollections } from 'fumadocs-mdx/config';

export const test = defineCollections({
  type: 'meta',
  dir: 'content/docs',
});

Docs 集合

为 Fumadocs 集成而组合 meta 和 doc 集合。

source.config.ts

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

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

内置属性

MDX 文件自动导出以下属性：

属性	用途
`frontmatter`	元数据块内容
`toc`	目录生成
`structuredData`	搜索实现支持
`extractedReferences`	链接引用分析

Fumadocs MDX

集合（Collections）

Doc 集合

Meta 集合

Docs 集合

内置属性

安装

子文档

性能优化

访问集合

框架集成

配置

功能

On this page