Fumadocs

什么是 Fumadocs

介绍 Fumadocs,这是一个你可以随意修改的文档框架。

Fumadocs 是由创建者 Fuma 创建的,因为他希望有一个更可定制的文档构建体验,成为一个不带偏见的文档框架,一个你可以“破坏”的“框架”

理念

更少抽象

虽然大多数框架使用配置文件进行配置,但当你希望调整细节时,它们通常缺乏灵活性。 你无法控制它们如何渲染页面或内部逻辑。

Fumadocs 期望你编写代码并与你的软件其他部分协作,它展示了应用的工作原理,并完全可定制,而不是使用配置文件。

无缝集成

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

对于 Next.js 开发者,你仍然在使用 App Router 的功能,比如 静态站点生成。对于 Next.js 开发者来说,没有什么新鲜事物,一切都对你来说很熟悉。

可组合 UI

Fumadocs UI(默认主题)提供的唯一东西是 用户界面。该 UI 带有偏见,以带来更好的移动响应性和用户体验。

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

服务器优先方法

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

然而,Fumadocs 引入了一种由 React Server Component 驱动的服务器优先方法。 凭借完美的服务器-客户端边界,内容变得动态和交互式。

你可以从服务器获取数据来显示内容,或与 CMS 集成接收实时更新。它始终是最新的且易于维护。

极简

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

虽然我们不旨在提供人们想要的所有功能,但我们更注重使基本功能完美且维护良好。 你也可以通过贡献来帮助 Fumadocs 变得更有用!

何时使用 Fumadocs

Fumadocs 设计时考虑了灵活性,它不限于特定用法。

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

对于大多数 Web 应用,纯 React.js 已经不再足够。 如今,我们还希望有一个博客、展示页面、FAQ 页面等。在这些情况下,Fumadocs 可以帮助你更容易地构建文档,减少样板代码。

如果你感兴趣,可以阅读比较

文档

Fumadocs 专注于 创作体验,它提供了一个美丽的主题和许多文档自动化工具。

它帮助你更快地迭代你的代码库,同时不会让你的文档落伍。 你可以将此站点作为使用 Fumadocs 构建的文档站点示例。

博客站点

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

Fumadocs 提供额外的工具,包括语法高亮、文档搜索和默认主题(Fumadocs UI)。 它帮助你避免重新发明轮子。

How is this guide?

Last updated on