你喜爱的 React.js 文档框架。

打造出色的
文档,
展现你的风格

Fumadocs 是一个为开发者设计的 React.js 文档框架,由 Fuma Nama 精美设计。 为你的文档工作流程带来强大功能,具有高度可定制性以适应你的偏好,无缝兼容任何 React.js 框架、CMS —— 任何平台。

试一试。

pnpm create fumadocs-app

localhost:3000

New App launched!
Terminal
pnpm create fumadocs-app ◇ Project name│ my-app◆ Choose a framework│ ● Next.js│ ○ Tanstack Start│ ○ React Router
preview

极简美学,最大化可定制性。

Fumadocs 提供设计精良的主题,并具备无头模式,可接入你自己的 UI。

专业设计师?使用 Fumadocs CLI 定制主题。

pnpm dlx @fumadocs/cli customise

> Choose a layout to customise...

任何人都可以编写。

原生支持 Markdown 和 MDX,为非开发者作者、开发者和 AI 代理提供直观、方便且丰富的语法。

---
title: Hello World
---

## Overview

I love **Fumadocs**!

```ts tab="Tab 1"
console.log("Hello World")
```

```ts tab="Tab 2"
return 0;
```

熟悉的语法。

它只是 Markdown,只是在语法中无缝地添加了额外的功能。

  • Markdown 功能,包括图片
  • 语法高亮(由 Shiki 提供支持)
  • 代码块组
  • 标注
  • 卡片
  • 自定义标题锚点
  • 自动目录

工程师文档。

框架无关

官方支持 Next.js、Tanstack Start、React Router、Waku — 可移植到任何 React.js 框架。

Next.jsReact Router

一个真正可组合的框架。

分为内容核心用户界面,提供工程师喜爱的高可组合性——你可以将 Fumadocs 作为一个库使用,而无需适配整个框架。

fumadocs-mdx

Use MDX in your React framework elegantly.

fumadocs-core

Headless library for building docs + handling content.

fumadocs-ui

UI library for building docs.

fumadocs-openapi

Extend Fumadocs to render OpenAPI docs.

fumadocs-obsidian

Extend Fumadocs to handle Obsidian-style Markdown.

采纳你的内容。

Fumadocs 旨在与任何内容来源集成,支持 MDX、内容集合,甚至你自己的 CMS。

Fumadocs MDX
import { loader } from 'fumadocs-core/source';
import { docs } from 'fumadocs-mdx:collections/server';

export const source = loader({
  source: docs.toFumadocsSource(),
  baseUrl: '/docs',
});

My CMS

My Page
Article
Another Page
Article
Components
Article
Getting Started
Article
MDX Editor
---
title: Hello World
---

# Hello World!

This is my first document.

提升你的搜索体验。

轻松将你的文档与 Orama 搜索和 Algolia 搜索集成。

了解更多
Search...

Getting Started

Use Fumadocs in your project.

Components

The UI Components for your docs.

MDX Content

Using MDX for content.

User Guide

How to use Fumadocs.

用于文档的 shadcn/ui

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

命令
shadcn