什么是 Fumadocs

介绍 Fumadocs，一个你可以拆解的文档框架。

Fumadocs 框架指的是 UI + Core + 内容源的组合，Fumadocs 更像是一种思维框架，每一层本身都可以是一个独立的库。

设计理念

Fumadocs 的创建是为了带来更具可定制性的文档构建体验，成为一个不偏执的文档框架，一个「你可以拆解」的框架。

更少的抽象

大多数框架通过配置文件进行配置，当你希望微调细节时，通常缺乏灵活性。你无法控制它们如何渲染页面，也无法控制内部逻辑。

Fumadocs 期望你编写代码并与你的软件其余部分协作，它会向你展示应用是如何工作的，并且完全可定制，而不是一个配置文件。

无缝集成

Fumadocs 与你的 React 框架紧密集成，带来实用的工具和一个美观的 UI。

对于 Next.js 开发者，你依然在使用 App Router 的特性，例如静态站点生成（SSG）。对于 Next.js 开发者来说一切都很熟悉，没有新东西需要学习。

可组合的 UI

Fumadocs UI（默认主题）所提供的唯一东西就是用户界面。该 UI 在带来更好的移动端响应式和用户体验方面有自己的主张。

相反，我们遵循一种受 Shadcn UI 启发的更灵活的方法 —— Fumadocs CLI，允许你「分叉（fork）」Fumadocs UI 的一部分，并完全自定义它。

服务端优先的方法

传统上，静态站点生成器是静态的。

然而，Fumadocs 引入了由 React Server Component 驱动的服务端优先方法。拥有完美的服务端-客户端边界，内容变得动态且可交互。

你可以从服务端获取数据来展示内容，或与 CMS 集成接收实时更新。它始终保持最新且易于维护。

极简

Fumadocs 由 Fuma 和许多贡献者维护，注重代码库的可维护性。

虽然我们不想提供人们想要的所有功能，但我们更专注于把基础功能做到完美且维护良好。你也可以通过贡献来帮助 Fumadocs 变得更有用！

何时使用 Fumadocs

Fumadocs 在设计时考虑到了灵活性，它并不局限于某些特定用途。

• fumadocs-core 是一个用于构建文档的无头（headless）UI 库。
• fumadocs-mdx 是一个用于处理 MDX 内容的有用库。

对于大多数 Web 应用，原生 React.js 已经不够用了。如今，我们还希望拥有博客、展示页、FAQ 页等。在这些情况下，Fumadocs 可以帮助你以更少的样板代码更轻松地构建文档。

如果你感兴趣，可以阅读 框架对比。

文档站点

Fumadocs 专注于写作体验，它提供了一个美观的主题以及许多文档自动化工具。

它帮助你在快速迭代代码库的同时，绝不落下文档。你可以把本站点当作用 Fumadocs 构建的文档站点示例。

博客站点

大多数 React.js 框架已经能够满足博客站点的需求。

Fumadocs 提供了额外的工具，包括语法高亮、文档搜索和一个默认主题（Fumadocs UI）。它帮助你避免重复造轮子。