构建您的文档

用更少的精力
构建出色的文档

Fumadocs 是一个为开发者设计的美丽文档框架,灵活、高性能,运行在您的 React 框架上。

preview

受到优秀团队和开发者的信赖

展示案例

您知道每次开始新项目时都需要重新构建完整的文档站点吗? Fumadocs 通过提供所有合适的构建块来解决这个问题,您可以组合使用这些块。 就像无头文档一样,可以精确构建您需要的内容。

头像

shadcn

Shadcn UI 创建者

特别感谢 @fuma_nama 创建了 fumadocs,这是一个华丽的文档框架,可以完美地集成到 App Router 中。

头像

Anthony Shew

Vercel Turbo DX

fumadocs 是最好的 Next.js 文档框架

头像

Aiden Bai

Million.js 创建者

如果没有它,我根本不可能构建出看起来有一半这么好的 @arktypeio 文档 😍

头像

David Blass

Arktype 创建者

您知道每次开始新项目时都需要重新构建完整的文档站点吗? Fumadocs 通过提供所有合适的构建块来解决这个问题,您可以组合使用这些块。 就像无头文档一样,可以精确构建您需要的内容。

头像

shadcn

Shadcn UI 创建者

特别感谢 @fuma_nama 创建了 fumadocs,这是一个华丽的文档框架,可以完美地集成到 App Router 中。

头像

Anthony Shew

Vercel Turbo DX

fumadocs 是最好的 Next.js 文档框架

头像

Aiden Bai

Million.js 创建者

如果没有它,我根本不可能构建出看起来有一半这么好的 @arktypeio 文档 😍

头像

David Blass

Arktype 创建者

您知道每次开始新项目时都需要重新构建完整的文档站点吗? Fumadocs 通过提供所有合适的构建块来解决这个问题,您可以组合使用这些块。 就像无头文档一样,可以精确构建您需要的内容。

头像

shadcn

Shadcn UI 创建者

特别感谢 @fuma_nama 创建了 fumadocs,这是一个华丽的文档框架,可以完美地集成到 App Router 中。

头像

Anthony Shew

Vercel Turbo DX

fumadocs 是最好的 Next.js 文档框架

头像

Aiden Bai

Million.js 创建者

如果没有它,我根本不可能构建出看起来有一半这么好的 @arktypeio 文档 😍

头像

David Blass

Arktype 创建者

您知道每次开始新项目时都需要重新构建完整的文档站点吗? Fumadocs 通过提供所有合适的构建块来解决这个问题,您可以组合使用这些块。 就像无头文档一样,可以精确构建您需要的内容。

头像

shadcn

Shadcn UI 创建者

特别感谢 @fuma_nama 创建了 fumadocs,这是一个华丽的文档框架,可以完美地集成到 App Router 中。

头像

Anthony Shew

Vercel Turbo DX

fumadocs 是最好的 Next.js 文档框架

头像

Aiden Bai

Million.js 创建者

如果没有它,我根本不可能构建出看起来有一半这么好的 @arktypeio 文档 😍

头像

David Blass

Arktype 创建者

1

创建它。

通过命令初始化新的文档。

localhost:3000

New App launched!
Terminal
npm create fumadocs-app ◇ Project name│ my-app◆ Choose a content source│ ● Fumadocs MDX│ ○ Content Collections
2

编写。

编写内容,使用自动化工具和类型安全的数据验证。

---
title: 我的文档
---

## 介绍

你好世界
index.mdx
components.mdx
3

部署。

使用任何托管平台轻松部署您的文档。

深受用户喜爱。
为开发者而建。

源无关

您的源。您的选择

设计用于与任何内容源集成: Fumadocs 适用于 MDX、内容集合,甚至您自己的 CMS。

源
MDX 编辑器
# 你好世界!这是我的第一个文档。 <ServerComponent />

搜索集成

增强您的搜索体验。

轻松在您的文档中集成 Orama Search 和 Algolia Search。

了解更多
搜索...
入门指南
组件
MDX 内容
用户指南
Javascript SDK

Fumadocs CLI

文档界的 Shadcn UI

Fumadocs CLI 为您的文档创建交互式组件,为用户提供丰富的体验。

npx @fumadocs/cli add

亮点特性

轻量快速。

由 React Server Components 驱动,默认优化图片。

框架无关。

使用 Next.js、React Router 或 Tanstack Start 构建文档站点。

无障碍与用户体验优先。

专注于用户体验和无障碍访问。

服务端优先。

允许无缝 CMS 集成和与服务端集成的动态内容。

Markdown 和 MDX。

基于 Shiki 的语法高亮、Typescript Twoslash、OpenAPI 文档生成等。

个性化。

以舒适的方式自定义主题的高级选项。

用心设计

可拆解的框架。

Fumadocs 让构建美观文档、编写内容以及将内容转换为数据变得简单,适用于从 Next.js 到 React Router 的 React.js 框架。

架构图

We made it simple.

Fumadocs offers native support for Orama and Algolia Search, it is as easy as plugging a route handler. You can also use your own search modal to allow full control over the search UI.

import { source } from '@/lib/source';
import { createFromSource } from 'fumadocs-core/search/server';
 
export const { GET } = createFromSource(source);

由您共同实现。

Fumadocs 100% 由热情和开源社区驱动。

junaidanjum's avatararyasaatvik's avatarsiyamhosan's avatarkyrylolvov's avatarkane50613's avatarMichaelErmer's avataroutslept's avatarhyoban's avatarpomber's avatarrubenskj's avatarstaciax's avatarsebdanielsson's avatarcoderrshyam's avatarYonom's avatarremorses's avatarTwinki14's avatarjoulev's avatarxiaoyu2er's avatarzaidmukaddam's avatarGitstar-OC's avatar
+28
Some of our best contributors.

构建您的文档

轻量而华丽,犹如月光。

  • 电池续航有保障。积极维护,开放贡献。
  • 完全开源。开源项目,可在 Github 上获取。
  • 几秒内完成。使用 CLI 立即初始化新项目。
  • 阅读文档打开演示