快速开始
开始使用 Fumadocs
介绍
🌐 Introduction
Fumadocs (Foo-ma 文档) 是一个文档框架，设计目标是快速、灵活，并能无缝整合到你的 React 框架中。
Fumadocs 有不同的部分：
🌐 Fumadocs has different parts:
Fumadocs 核心
处理大部分逻辑，包括文档搜索、内容源适配器和 Markdown 扩展。
🌐 Handles most of the logic, including document search, content source adapters, and Markdown extensions.
Fumadocs 用户界面
Fumadocs 的默认主题为文档网站和交互组件提供了美观的外观。
🌐 The default theme of Fumadocs offers a beautiful look for documentation sites and interactive components.
你的内容来源可以是 CMS，也可以是本地数据层，如 Fumadocs MDX（官方内容来源）。
🌐 The source of your content, can be a CMS or local data layers like Fumadocs MDX (the official content source).
Fumadocs 命令行工具
一个用于安装用户界面组件和自动化操作的命令行工具，适合自定义布局。
🌐 A command line tool to install UI components and automate things, useful for customizing layouts.
想了解更多吗？
阅读我们深入的什么是Fumadocs介绍。
术语
🌐 Terminology
Markdown/MDX： Markdown 是一种用于创建格式化文本的标记语言。Fumadocs 原生支持 Markdown 和 MDX（Markdown 的超集）。
Bun： 一个 JavaScript 运行时，我们用它来运行脚本。
具备一些 React.js 的基础知识对于进一步的自定义会很有帮助。
🌐 Some basic knowledge of React.js would be useful for further customisations.
自动安装
🌐 Automatic Installation
需要至少 Node.js 22 版本。
🌐 A minimum version of Node.js 22 required.
npm create fumadocs-app它会询问你要使用的内置模板：
🌐 It will ask you the built-in template to use:
- React.js框架：Next.js、Waku、React Router、Tanstack Start。
- 内容来源：Fumadocs MDX。
新的fumadocs应用应该被初始化。现在你可以开始黑客操作了！
🌐 A new fumadocs app should be initialized. Now you can start hacking!
从现有代码库？
你可以按照手动安装指南开始使用。
享受吧！
🌐 Enjoy!
在 docs 文件夹中创建你的第一个 MDX 文件。
🌐 Create your first MDX file in the docs folder.
---
title: Hello World
---
## Yo what's up在开发模式下运行应用，并查看 http://localhost:3000/docs。
🌐 Run the app in development mode and see http://localhost:3000/docs.
npm run dev常见问题
🌐 FAQ
你可能会遇到的一些常见问题。
🌐 Some common questions you may encounter.
适用于 Vite
🌐 For Vite
适用于 Next.js
🌐 For Next.js
了解更多
🌐 Learn More
新来的吗？别担心，我们欢迎你的提问。
🌐 New to here? Don't worry, we are welcome for your questions.
如果你发现任何令人困惑的地方，请在 Github 讨论 上提供你的反馈！
🌐 If you find anything confusing, please give your feedback on Github Discussion!
撰写内容
🌐 Writing Content
在撰写文档时，请务必阅读：
🌐 For authoring docs, make sure to read:
Markdown
Fumadocs 具有一些用于创作内容的附加功能。
导航
了解如何自定义导航结构。
页面别名与页面结构
了解如何组织内容。
组件
See all available components to enhance your docs
特殊需求
🌐 Special Needs
Last updated on