Repolode
fuma-nama

fuma-nama/fumadocs

基于 React.js 构建文档网站的框架,支持 Next.js、Astro 及多种 Vite 生态的 React 框架。

Star
13,426
Fork
745
未关闭 Issue
0
最近提交
13小时前

这是什么?

Fumadocs 是一个用于在 React 技术栈中构建文档网站的框架,覆盖文档站点的常见需求,例如基于 MDX 的内容编写、导航和页面布局,让开发者可以把精力放在文档内容本身。

该项目官方支持 Next.js、Astro(配合 React)以及基于 Vite 的方案,包括 TanStack Start、Waku 和 React Router。所有包均仅以 ESM 格式发布,接入较旧的工具链时需要留意这一点。

完整文档和上手指南托管在 fumadocs.dev。项目使用 TypeScript 编写。

核心功能

  • 01支持基于 Next.js、配合 React 的 Astro 以及多种 Vite 生态 React 框架构建文档站点。
  • 02使用 MDX 编写文档内容。
  • 03提供文档站点所需的导航与页面布局组件。
  • 04所有包仅提供 ESM 格式。

适用场景

  • 在 Next.js 上搭建产品或开源库的文档网站。
  • 结合 React 组件,用 Astro 构建文档站点。
  • 为现有的 React Router 或 TanStack Start 应用添加文档板块。

快速上手

  1. 1

    访问 fumadocs.dev 文档开始使用

使用前须知

  • 所有包仅支持 ESM 格式。

标签

常见问题

fumadocs 是什么?
基于 React.js 构建文档网站的框架,支持 Next.js、Astro 及多种 Vite 生态的 React 框架。 Fumadocs 是一个用于在 React 技术栈中构建文档网站的框架,覆盖文档站点的常见需求,例如基于 MDX 的内容编写、导航和页面布局,让开发者可以把精力放在文档内容本身。
fumadocs 可以免费使用吗?用的什么许可证?
fumadocs 以 MIT 许可证开源。用于商业产品前,请先确认许可证条款。
fumadocs 还在维护吗?
活跃维护中。fumadocs 最近一次提交是在 2026年10月20日。
fumadocs 适合用来做什么?
在 Next.js 上搭建产品或开源库的文档网站。 结合 React 组件,用 Astro 构建文档站点。 为现有的 React Router 或 TanStack Start 应用添加文档板块。
fumadocs 怎么安装和运行?
访问 fumadocs.dev 文档开始使用
在哪里获取 fumadocs?
源代码和安装说明在 GitHub 上:https://github.com/fuma-nama/fumadocs

概要由 AI 根据项目 README 生成;GitHub 数据每日更新。

相关项目