blume

一份文档，人类看得爽，AI 也读得懂

开源 freemium 办公效率

访问官网 ↗ GitHub ↗ 文档 ↗

GitHub 星标 ★ 1777

维护状态活跃

是否开源是

定价模式 freemium

项目预览

项目数据

分类办公效率

开发团队haydenbleasel

所属国家

官网地址https://useblume.dev

GitHubhttps://github.com/haydenbleasel/blume

定价模式freemium

价格说明开源免费，官网提供在线托管服务，付费方案待确认

访问状态

是否开源是

开源协议MIT

主要语言TypeScript

技术栈/模型docs,mdx,typescript

GitHub 星标★ 1777

30天Star增速

HF 下载量

上线时间2026-06-21 00:00:00

代码更新—

仓库体积—

本站数据更新—

维护状态活跃

中文支持

访问方式

移动端支持

综合评分

收录时间2026-10-13

浏览次数0

项目介绍

Blume 是一个面向人类与 AI 代理的开源文档框架，基于 TypeScript 和 MDX 构建。它解决的核心问题是：传统文档工具只服务人类阅读，而 AI 代理难以高效解析和利用文档内容。Blume 让同一份文档既能以美观的网页形式呈现给用户，又能以结构化、语义清晰的方式被 AI 代理读取和推理。核心能力包括：MDX 驱动的内容编写、对代理友好的输出格式、类型安全的配置与扩展、以及开箱即用的文档站点生成。它适合需要同时服务人类读者和自动化代理的团队，比如 API 文档、产品手册、知识库等场景。相比纯静态站点生成器，Blume 更强调内容对机器可读性的优化，让文档成为 AI 工作流中的一等公民。

Star 增长趋势

本站每日记录该项目 GitHub 星标变化，观测越久曲线越完整

正在加载星标数据…

技术标签

使用教程

—

难度：入门约 10 分钟部署方式：命令行工具 5 步

环境要求

Node.js 22.19 或更高版本
一个内容文件夹，至少包含一个 .md 或 .mdx 文件
可用的 npm 或任意其他包管理器
可访问 npm 源以安装依赖

安装与启动步骤

1初始化文档项目

在空目录执行，会自动生成 docs/index.mdx、blume.config.ts 与 package.json，并安装依赖。
```
npx blume init
```
2启动开发服务器

在项目目录运行，带热重载，可在浏览器实时预览文档站点效果。
```
npm run dev
```
3构建静态站点

输出静态 HTML 和本地搜索索引到 dist/ 目录，用于后续部署。
```
npm run build
```
4接入现有项目

若项目已有 package.json，init 不会改动它，需自行添加 dev 与 build 脚本，或直接用 npx blume dev 启动。
```
npx blume dev
```
5配置部署适配器

需要助手或 MCP 服务器等请求时功能时，在 blume.config.ts 中从 blume/deploy 引入并指定适配器，构建会切换为服务端输出。

关键配置

配置项	必填	说明	示例
`deployment`	否	指定部署适配器，启用请求时功能并切换为服务端输出	`vercel()`
`scripts.dev`	否	package.json 中的开发脚本，指向 blume dev	`blume dev`
`scripts.build`	否	package.json 中的构建脚本，指向 blume build	`blume build`

如何确认成功

npm run dev 后本地开发服务器可打开并热重载；npm run build 成功生成 dist/ 目录及静态 HTML。

常见问题

Q：项目里已经有 package.json 会被覆盖吗？

A：不会。blume init 会保留原有 package.json，只需自行添加 "dev": "blume dev" 和 "build": "blume build" 两个脚本，或直接运行 npx blume dev。

Q：必须自己配置 Astro 或 Tailwind 吗？

A：不需要。Blume 会自动生成并驱动一个隐藏的 Astro 项目，无需手动搭建 Astro 或 Tailwind。

Q：想完全掌控项目结构怎么办？

A：运行 npx blume eject，可以导出一个独立的 Astro 应用，之后自行维护。

Q：需要请求时功能（助手、MCP 服务器）如何部署？

A：在 blume.config.ts 中命名 blume/deploy 提供的适配器，可选 vercel()、netlify()、node()、cloudflare()，构建会切换为服务端输出。

Q：从 Mintlify、Docusaurus 等迁移方便吗？

A：可以，运行 npx blume migrate 即可把已有文档站点交给 Claude Code 或 Codex 处理迁移。

注意事项

站点地址在 Vercel、Netlify 和 Cloudflare Pages 上会自动检测，但部署适配器不会自动识别，必须在 blume.config.ts 中显式指定。
blume build 输出到 dist/，可部署到任意静态托管（Vercel、Netlify、Cloudflare Pages、GitHub Pages、S3 + CloudFront 等 CDN）。
Node.js 版本必须为 22.19 或更新，低于该版本可能无法运行。
Blume 1 用户可运行 npx blume@latest upgrade 升级到 Blume 2。

核心亮点

同时优化人类阅读体验和 AI 代理解析，一份内容两端可用
基于 MDX 和 TypeScript，类型安全且扩展灵活
轻量专注，不捆绑复杂生态，上手成本低

不足之处

项目较新，生态插件和主题丰富度有限
社区规模和长期维护稳定性有待观察

适用场景

为 API 产品编写同时面向开发者和 AI 助手的文档
构建企业内部知识库，供员工和自动化代理共同查询
开源项目文档站，既服务访客也便于 AI 工具抓取

替代项目

Docusaurus、Nextra

上一篇：video-devour

下一篇：没有了！