Fumadocs

Fumadocs 是一个文档框架，帮助开发者使用 React 和 Next.js 构建专业的文档网站。与传统的文档工具不同，它让你完全掌控内容和设计，同时自动处理复杂部分。

它支持使用 Markdown 和 MDX 编写内容，这意味着你可以使用简单的文本格式或添加交互式的 React 组件。该框架内置搜索、语法高亮和精美的预设计主题。它还兼容任何内容来源，无论你将文档存储在文件、数据库还是内容管理系统中。

Fumadocs 由三部分组成：用于管理文档的内容层、提供搜索等功能的核心库，以及用于美观组件的 UI 库。你可以根据需要灵活使用。

开始使用 Fumadocs 非常简单。步骤如下：

• 安装框架，在终端运行命令 npm create fumadocs-app。根据提示选择你喜欢的 React 框架和内容来源。

• 编写内容，在 docs 文件夹内使用 MDX 文件。使用简单的 Markdown 语法，并可添加 React 组件以实现交互元素。

• 自定义外观，使用 Tailwind CSS。你可以更改颜色、布局和样式，以匹配你的品牌，无需学习新的系统。

• 添加搜索功能，只需几行代码即可连接 Orama 或 Algolia 搜索。框架会自动处理其余部分。

• 使用 CLI 工具，通过命令 npx @fumadocs/cli add 添加交互组件，如标签页、提示框和代码块。

• 部署你的网站，到 Vercel、Netlify 或任何支持 Next.js 应用的托管服务。

• 免费且开源的框架

• 支持 Next.js、React Router 及其他 React 框架

• 使用 Markdown 和 MDX 编写内容

• 内置搜索，支持 Orama 和 Algolia

• OpenAPI 文档生成器

• 集成 TypeScript Twoslash

• 精美的预设计 UI 组件

• 命令行工具，轻松设置

• 使用 Shiki 进行语法高亮

• 高度可定制，支持 Tailwind CSS