fumadocs README

The project's README from github.com/fuma-nama/fumadocs. As one markdown file: README.md.

banner

The framework for building documentation websites in React.js frameworks and Astro.

Officially Supported:

📘 Learn More: Documentation.

Compatibility

All packages are ESM only.

Sticker

logo

Welcome to print it out :D

Contributions

Make sure to read the Contributing Guide before submitting a pull request.

fumadocs (fuma-nama/fumadocs)

Searching Database…

13.4K ·GitHub
这是什么?Fumadocs 是一个用于在 React.js 框架和 Astro 中构建文档网站的框架,内置搜索、主题和 MDX 内容处理功能。
它是框架,还是即插即用的组件集?它是一个文档框架,而不是独立的应用:你需要把它添加到 Next.js、Astro,或基于 Vite 的 React 方案(如 Tanstack Start、Waku 或 React Router)之上,才能生成你的文档网站。
我该如何把它添加到项目中?你可以将 Fumadocs 添加到官方支持的 React 方案之一(Next.js、搭配 React 的 Astro,或基于 Vite 的框架),并用 MDX 编写内容。完整的设置步骤见官方文档。
我必须使用 Next.js 吗,还是可以用别的?不必,Next.js 只是其中一种选择;搭配 React 的 Astro,以及 Tanstack Start、Waku、React Router 等基于 Vite 的框架,同样受到官方支持。
安装时有哪些需要注意的坑吗?Fumadocs 的所有包都只支持 ESM,因此你需要使用支持 ESM 导入的模块配置,而不是 CommonJS。
Fumadocs 开箱即支持 Tailwind CSS 样式吗?支持。Tailwind CSS 集成与 MDX 内容处理一同列在其支持的工具之中。
我可以使用哪些内容来源配合 Fumadocs?它可以与 MDX、content-collections 和 Contentlayer 配合使用,用于管理文档内容。
有没有一种直观的方式来展示我在使用 Fumadocs?该项目提供了一张可打印的贴纸,供粉丝表达支持。
Creator
fuma-nama
Size
142.1 MB
Stars
13.4K
Age
3y
Commits · 90 Days