快速开始
从零开始使用 Fumadocs 构建文档站点
介绍
Fumadocs（读作 "Foo-ma docs"）是一个文档框架，专为速度、灵活性和与 React 框架的无缝组合而设计。
Fumadocs 由以下几个部分组成：
Fumadocs Core
处理大部分逻辑，包括文档搜索、内容源适配器和 Markdown 扩展。
Fumadocs UI
Fumadocs 的默认主题，为文档站点提供精美外观和交互组件。
内容源
你的内容来源 — 可以是 CMS 或本地数据层，如 Fumadocs MDX（官方内容源）。
Fumadocs CLI
命令行工具，用于安装 UI 组件和自动化操作，在自定义布局时非常实用。
想了解更多？
阅读我们的深度介绍文章：什么是 Fumadocs。
术语
- Markdown/MDX： Markdown 是一种用于创建格式化文本的标记语言。Fumadocs 原生支持 Markdown 和 MDX（Markdown 的超集）。
- Bun： 一个 JavaScript 运行时，我们用它来运行脚本。
一些基础的 React.js 知识对后续的自定义会有帮助。
自动安装
需要 Node.js 22 或更高版本。
npm create fumadocs-app安装程序会提示你选择内置模板：
- React.js 框架：Next.js、Waku、React Router、Tanstack Start
- 内容源：Fumadocs MDX
初始化后的 Fumadocs 应用默认配置了以下功能：
已有项目？
你可以按照手动安装指南来集成 Fumadocs。
开始使用！
在 docs 文件夹中创建你的第一个 MDX 文件：
---
title: Hello World
---
## Yo what's up以开发模式运行应用，然后访问 http://localhost:3000/docs：
npm run dev常见问题
遇到缺少 API 或 Bug 的错误？
请确保你使用的是最新版本的 Fumadocs，并检查 GitHub Issues 获取已知问题。
如何更改文档的基础路由？
修改 app/docs 目录的路径即可更改基础路由。
如何实现多文档？
创建多个内容源和对应的路由即可。
了解更多
有问题随时欢迎！如果你发现任何令人困惑的地方，请在 Github Discussion 上给出你的反馈！
编写内容
对于文档作者，请务必阅读：