什么是 Docfuse
Docfuse 是面向代码仓库的静态文档站点生成器。它直接读取仓库中的 Markdown、MDX 和配置，一次构建生成网站、本地搜索与 AI 可读数据。
它适合把文档和代码放在一起维护的团队。接入时不改业务源码，也不需要单独维护文档前端；开发、检查、构建和预览都由同一个 CLI 完成。
低侵入接入现有仓库
文档、配置和命令脚本都留在原仓库。docfuse init 只补齐缺少的文件；已有 Markdown 和 MDX 会在原目录接入，不会被移动或覆盖。
构建结果是静态文件。部署后不需要运行 Docfuse 服务、Node.js 服务器或数据库。
一份内容生成多种产物
同一批 Markdown 和 MDX 会生成完整静态站点、本地搜索索引、Markdown 镜像、llms.txt 和分片语料。网站、搜索和 AI 工具读取同一内容源，不需要分别维护。
导航、侧栏、多语言和版本路由也从文档结构与配置生成，不需要另写一套页面数据。
主要能力
| 编写内容 | Markdown、MDX、本地 React 组件、代码、表格、文件树、媒体、数学和图表 |
| 组织站点 | 路由、导航、侧栏、页内目录、搜索、SEO、多语言和多版本 |
| 检查内容 | 配置、Frontmatter、链接、静态资源和翻译缺口 |
| 构建与发布 | 完整静态 HTML、重定向、搜索索引和可直接部署的产物 |
| 提供 AI 内容 | Markdown 镜像、llms.txt、页面索引和分片数据 |
具体写法见 Markdown，建站流程见快速开始，配置字段见参考。
三个包怎样选择
docfuse | 构建完整文档站点 |
@docfuse/markdown | 在现有 React、SSR 或静态生成项目中渲染 Markdown 和 MDX |
@docfuse/plugins | 提供数学、图表、链接处理、阅读时长和 Pagefind 插件 |
构建站点只需安装 docfuse。另外两个包用于单独渲染内容或按需加入插件。
适用范围
Docfuse 适合 SDK、API、CLI、组件库、开源项目和工程知识库，尤其适合需要多语言、版本管理或 AI 文档输出的项目。
Docfuse 不是在线 CMS，也不是托管服务。它不提供多人在线编辑、账户、权限、评论审批或动态内容接口；私有文档需要由托管平台保护整个静态输出目录。
MDX、本地组件和构建扩展会执行代码，只应处理可信内容。具体边界见安全边界。
准备开始时，先安装 Docfuse。想查看内容效果，可以打开 Markdown Playground。