Fumadocs 快速上手
了解 Fumadocs 的核心组成，并快速启动你的第一个文档站点。
认识 Fumadocs
Fumadocs (Foo-ma docs) 是一个构建在 Next.js 之上的 文档框架。 它强调速度、灵活性，以及和 Next.js App Router 的自然配合。
整个项目主要由以下几部分组成：
Fumadocs Core
Handles most of the logic, including document search, content source adapters, and Markdown extensions.
Fumadocs UI
The default theme of Fumadocs offers a beautiful look for documentation sites and interactive components.
Content Source
The source of your content, can be a CMS or local data layers like Content Collections and Fumadocs MDX, the official content source.
Fumadocs CLI
A command line tool to install UI components and automate things, useful for customizing layouts.
想了解更多？
阅读我们深入的 什么是 Fumadocs 介绍。
先了解几个概念
Markdown/MDX: Markdown 是一种用于编写格式化文本的标记语言。Fumadocs 默认同时支持 Markdown 与 MDX（Markdown 的超集）。
如果你后续准备继续做深度定制，先了解一些 Next.js App Router 的基础知识也会很有帮助。
自动创建项目
你需要使用 Node.js 18 或更高版本。需要注意的是，Node.js 23.1 在 Next.js 生产构建中可能会出现问题。
npm create fumadocs-apppnpm create fumadocs-appyarn create fumadocs-appbun create fumadocs-app脚手架会询问你要使用的框架和内容源，然后自动初始化一个新的 Fumadocs 项目。
从现有代码库开始？
您可以按照 手动安装 指南开始。
第一篇文档
完成初始化后，可以先在 docs 目录里创建一个最简单的 MDX 文件。
---
title: Hello World
---
## Yo what's up启动开发服务器后，访问 http://localhost:3000/docs 即可查看。
npm run dev看看生成出来的项目
默认生成的项目里，通常会包含这些关键文件：
lib/source.ts：内容源适配器所在位置。loader()会提供读取内容与分配页面 URL 的接口。app/layout.config.tsx：共享布局配置。它不是强制要求的，但通常建议保留。
| 路由 | 描述 |
|---|---|
app/(home) | 您的登陆页面和其他页面的路由组。 |
app/docs | 文档布局和页面。 |
app/api/search/route.ts | 搜索的路由处理器。 |
开始写文档
当你真正开始编写内容时，下面这两篇会比较值得先看：
内容源
内容源负责处理文档管线，例如 Markdown 编译与 frontmatter 校验。
阅读 介绍 了解它如何处理您的内容。
项目中已包含 source.config.ts 配置文件，您可以自定义不同的选项，如前言模式。
Fumadocs 不仅限于 Markdown。对于其他源（如 Sanity），您可以构建 自定义内容源。
定制 UI
请参阅 自定义指南。
常见问题
下面整理了新手最常遇到的几类问题。
继续了解
如果你刚接触 Fumadocs，也完全不用担心，欢迎继续提问。
如果有任何地方让你感到困惑，也欢迎在 Github Discussion 中反馈。
更多文章
Orelune Tarot Series: Three of Wands - Expansion, Foresight, and Steady Progress
Discover the Three of Wands tarot meaning with Orelune, including growth, opportunity, love, career, symbolism, and practical yes/no interpretation.
Orelune 上的 22 张大阿尔卡那解析
用更清晰的方式理解大阿尔卡那 22 张牌义。从愚者到世界，查看每张牌如何对应人生课题、爱情、转变与命运，并结合 Orelune 的解读思路。
Orelune塔罗系列：权杖王后牌义——自信、魅力与独立
在 Orelune 了解权杖王后牌义，涵盖自信、吸引力、领导气场、象征意象与是或否判断。
邮件列表
加入我们的社区
订阅邮件列表，及时获取最新消息和更新