【免费下载链接】blume
The open-source docs framework for humans and agents.
Blume 是一个 MIT 协议的开源文档框架,基于 Astro 与 Vite 构建,主打零配置与AI 就绪两大卖点:把 Markdown/MDX 丢进文件夹,跑一条命令就能得到带导航、搜索、主题、Open Graph 图片和组件库的生产级文档站,并原生提供llms.txt、原始 Markdown 接口、JSON API 与 MCP 服务器。它既是 Mintlify 这类托管平台的免费替代品,也无需像 Docusaurus 那样自己维护一整套应用脚手架——这就是本文带你完整解析 Blume 的原因。
为什么 Blume 是 Docs 框架的新选择?
市面上的文档工具大多处于两个极端:
| Blume | Mintlify(托管平台) | Fumadocs / Nextra / Docusaurus | |
|---|---|---|---|
| 模式 | 零配置框架,只写内容 | 托管平台,构建部署归厂商 | 开源库 + 自己搭建的应用 |
| 源码 | 开源(MIT) | 闭源内核 | 开源 |
| 部署 | 任意静态托管或自托管 | 厂商托管基础设施 | 任意,但需自己构建部署 |
| 你要维护的 | 只有 Markdown | Markdown + 平台配置 | Markdown + 周边应用 |
| AI 能力 | llms.txt、原始 Markdown、页内助手、MCP,全部内置且无托管服务 | 内置(依赖托管) | 需要自己集成 |
Blume 走的是第三条路:框架即模板。你只写内容,导航、搜索、主题、SEO、AI 端点全部由框架生成驱动;同时完全开源、可自托管,没有锁定。想要完全掌控时,blume eject一键把项目变成独立的 Astro 应用。
三步起步:从空文件夹到文档站
Blume 只要求Node.js 22.19+和一个至少包含一个.md/.mdx文件的目录,其余全部自动完成 🚀:
- 创建项目:
npx blume init——交互式询问站点名称与内容目录,自动生成docs/index.mdx、blume.config.ts和带dev/build脚本的package.json; - 启动开发服务器:
npm run dev——支持热更新,开发体验是 Vite 原生的速度; - 构建生产站点:
npm run build——输出静态 HTML 与本地搜索索引到dist/,可部署到任意静态托管。
完整步骤见 01-quickstart.mdx,核心概念见 index.mdx。
💡 已有
package.json的项目也能无缝加入:blume init不会动现有文件,只需给 scripts 加两行blume dev/blume build。
零配置到底意味着什么?
一个装文档的文件夹就是一个完整项目。没有 starter 要克隆、没有 Astro 或 Tailwind 要配置:
- 导航从文件结构自动推断,需要微调时再写
meta.ts; - 搜索开箱即用——默认 Orama 本地运行,不依赖任何托管服务;
- 主题只需几个设计令牌,核心主题默认零客户端框架 JS,Core Web Vitals 表现优秀;
- 类型安全的配置——blume.config.ts 和每个
meta.ts都是真 TypeScript,defineConfig/defineMeta提供编辑器自动补全与校验。
工作原理很简洁:CLI 扫描内容构建内容图,在隐藏的.blume/目录下生成并驱动一个 Astro 项目,每次运行只写入变更文件,热更新因此保持飞快。细节可参考 README.md。
AI 就绪:让文档同时服务人类与 Agent
这是 Blume 与 Mintlify、Docusaurus 拉开差距的地方——每个站点都"会说机器语言":
- 📄
llms.txt与llms-full.txt:为 LLM 生成的站点摘要; - 🔗原始 Markdown 直出:任意页面 URL 加
.md后缀即可获取纯净 Markdown,天然适合 RAG 抓取; - 🔍JSON 文档 API:以 OpenAPI 描述的机器可读接口,方便构建搜索与问答;
- ⚡Copy as Markdown / Open in chat:每页都有的读者动作;
- 🤖 **页内 AI 助手(可选)**与MCP 服务器:Claude Code、Cursor 等编码 Agent 可以直接搜索和读取你的文档,无需爬取。
相关实现集中在 packages/blume/src/ai/,其中llms.ts、mcp/、ask.ts分别对应上述能力;产品侧说明见 discoverability 目录。更进一步,Blume 内置了Agent Skills——一套教编码 Agent 搭建与维护文档站的手册,例如blume-migrate(迁移)与blume-update-docs(自动审查 PR、changelog 并更新过时文档页),源码在 skills 目录,可直接安装到 Claude Code 或 Codex 中使用。
一键迁移:从 Mintlify 与 Docusaurus 平滑切换
迁移文档站需要判断力:哪些导航变成文件夹、哪些组件变成指令、哪些没有对应物。所以blume migrate把这项工作交给编码 Agent(Codex 或 Claude Code),按官方迁移手册执行,你只需审查每一处改动:
npx blume migrate docusaurus --claude支持的来源包括 Mintlify、Docusaurus、GitBook、MkDocs、Fern、ReadMe、Fumadocs、Nextra、Starlight、VitePress、VuePress 等十余种,框架会自动检测。Agent 会生成blume.config.ts、重写页面、为所有旧 URL 添加重定向,并运行构建与链接校验直到通过 ✅。迁移手册见 04-migrating.mdx,各框架对照页在 compare 页面,迁移技能文档见 blume-migrate/SKILL.md。
常用 CLI 命令速查表
| 命令 | 作用 |
|---|---|
blume init [dir] | 脚手架创建项目(默认交互式) |
blume dev/blume build | 开发服务器 / 构建静态站点 |
blume audit | 审计已构建站点的 SEO 与健康问题 |
blume validate | 校验内部、锚点、资源与外部链接 |
blume eval | 让 Agent 仅用文档回答问题,测试文档质量 |
blume translate | 用本地 Agent CLI 翻译到配置的语言 |
blume eject | 生成独立 Astro 应用,获得完全控制权 |
完整参数见 CLI 参考。
部署与自定义:静态优先,按需升级
blume build输出静态 HTML 到dist/,可部署到 Vercel、Netlify、Cloudflare Pages、S3 + CDN 或任意自托管环境。需要助手、MCP 等请求期特性时,在配置中指定blume/deploy的适配器(vercel()、netlify()、node()、cloudflare())即可切换为服务端构建,站点 URL 还会自动探测。
自定义路径同样分层递进:覆写内置组件 → 加 React 岛屿(只有用到 React 时才加载框架 JS)→ Tailwind v4 主题令牌 → 组件注册表(blume add)→blume eject拿到整个 Astro 项目。此外还有 i18n 多语言路由、OpenAPI/AsyncAPI/GraphQL 规范渲染为原生 API 参考页、客户端 PDF/EPUB 导出等能力,细节见 02-deployment.mdx。
总结:Blume 适合谁?
- 🏃个人开发者:不写一行框架代码,分钟级上线文档站;
- 🏢开源项目团队:免费、MIT、可自托管,告别托管平台账单与锁定;
- 🤖AI 优先的团队:
llms.txt、MCP、JSON API 让文档直接成为 LLM 的知识源; - 📦想迁移的团队:一条命令 + Agent 从 Mintlify、Docusaurus 等平滑过渡,旧链接自动重定向。
如果你想体验"内容即项目"的文档工作流,Blume 值得放进你的工具链试试。
【免费下载链接】blume
The open-source docs framework for humans and agents.
相关推荐
抖音下载工具:批量下载、去水印与直播录制实操指南
抖音下载工具:批量下载、去水印与直播录制实操指南 douyin downloader 是一个命令行抖音批量下载工具:给一条链接加一份 YAML 配置,视频、图文
网页爬虫CLIKaf:现代Kafka命令行工具终极指南 - 10个高效使用技巧
Kaf:现代Kafka命令行工具终极指南 10个高效使用技巧 Kaf是一款用Go语言编写的现代Apache Kafka命令行工具,它为开发者和运维人员提供了简洁
flatpickr完全指南:零依赖JavaScript日期时间选择器,一个组件搞定日期、时间、范围与多选
flatpickr完全指南:零依赖JavaScript日期时间选择器,一个组件搞定日期、时间、范围与多选 flatpickr 是一款 零依赖、轻量级 的 Jav
前端UI组件
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考