Blume：一个开源、零配置的文档框架，从Markdown文件夹生成AI就绪文档

Hayden Bleasel，来自 OpenAI 的专家开发者，发布了 Blume，一个开源的文档框架。Blume 在当天作为版本 1.0.3 发布到 npm。它的理念简单：将 Markdown 放入文件夹，然后交付一个文档站点。无需编写或维护任何应用样板代码。该项目采用 MIT 许可并开源。

什么是 Blume？

Blume 是一个命令行工具，配有一个用于文档的组件库。它读取一个 Markdown 或 MDX 文件文件夹，从中生成一个生产级文档站点。该输出包含导航、搜索、主题和 Open Graph 图像。配置保持可选，可逐个文件添加。代码是一个 TypeScript monorepo；发布的包位于 packages/blume。Blume 自身的文档位于 apps/docs，由 Blume 自身构建。它需要 Node.js 22.12 或更高版本。支持 Bun、pnpm、npm 或 yarn 运行。

Blume 如何工作？

在表面之下，Blume 生成并驱动一个隐藏的 Astro 项目。首先，CLI 加载 blume.config.ts 并将内容扫描成图谱。接着，它将一个 Astro 项目写入 .blume/ 目录。然后 Astro 通过一个单一的 catch-all 路由渲染每个页面。该路由导入 Blume 附带的组件、生成的数据以及你的覆盖项。每次运行时，.blume/ 重新生成，且仅重写更改的文件。因此，编辑期间热重载保持快速。核心主题不运送客户端框架 JavaScript。因此，页面默认在 Core Web Vitals 上得分良好。当你需要完全控制时，blume eject 将运行时提升为独立的 Astro 应用。该项目仍然依赖于 blume 包。

快速开始

设置只需一条命令，因此上手很快。

npx blume init

之后，blume dev 启动一个热重载服务器。同时，blume build 将静态 HTML 和本地搜索索引写入 dist/。配置文件是真实的 TypeScript，由 schema 验证。

// blume.config.ts import { defineConfig } from "blume";

export default defineConfig({ content: { sources: [ { type: "filesystem", root: "docs" }, { type: "notion", database: process.env.NOTION_DB }, ], }, });

由于配置有类型，编辑器能在构建前捕捉错误。CLI 涵盖基本命令之外的完整生命周期。

AI 就绪的设计

除了人类读者，Blume 也面向 AI 代理。每个页面在 URL 后添加 .md 时返回原始 Markdown。一个标志即可为代理生成 llms.txt 和 llms-full.txt。每个页面可复制为 Markdown 或在 ChatGPT、Claude 或 v0 中打开。可选的内页 Ask AI 助手直接回答读者问题。它运行在 AI SDK 上，通过 Vercel AI Gateway、OpenRouter、Inkeep 或任何兼容 OpenAI 的端点。Blume 还可以托管 Model Context Protocol (MCP) 服务器。通过它，Claude Code、Cursor 和 VS Code 直接读取文档。

Claude MCP 添加命令示例： claude mcp add --transport http your-docs https://docs.example.com/mcp

该服务器暴露四个只读工具：search_docs、get_page、list_pages 和 get_navigation。

用例示例

这些能力对应具体任务。对于 API 产品，放入 OpenAPI 或 AsyncAPI 规范。Blume 然后渲染交互式参考，包含 schema、认证和通过 Scalar 的请求测试。对于库，将 Blume 指向 GitHub Releases。每个发布汇总到带有 RSS 源的生成变更日志时间线。对于全球受众，按语言添加翻译文件。Blume 支持 36 种语言、语言感知路由和从右到左布局。对于混合内容，结合本地文件与远程 MDX、Notion 或 Sanity。所有源通过相同组件渲染。

全球最佳文档框架简介

一个适合你所有交付的世界级文档框架。将 Markdown 放入文件夹，无需应用样板代码即可交付完整文档站点。→ 零配置设置 → 自动 SEO 和 AEO → 30+ 组件 → 由 Astro + Vite 驱动 → 开源，永久免费。

比较

为了背景，这里将 Blume 与三种常见文档方法对比。功能变化很快，因此在你采用前请验证当前细节。

表格略（翻译时保留比较维度）

优势和劣势

优势：零配置启动；静态优先输出无核心客户端 JS；内建 AI 表面；类型安全配置；可提升为独立 Astro 应用减少长期锁定。

劣势：版本 1.0.3 较新，生态系统尚在初期；需要 Node.js 22.12+；请求时功能需要服务器适配器；自托管需要自行处理分析和助手；第三方集成少于成熟托管平台。

关键要点

Blume 将 Markdown 文件夹变成零配置的生产级文档站点。它驱动隐藏的 Astro 和 Vite 项目，并可提升为独立 Astro。AI 功能内建：llms.txt、每页 Markdown 和 MCP 服务器。MIT 许可，需要 Node.js 22.12+。早期采用者包括从 Mintlify 迁移的 Quiver 和 Neon 的 add-mcp 文档。

查看 GitHub 仓库。也欢迎关注我们的 Twitter，别忘了加入我们的 150k+ML SubReddit 和订阅我们的通讯。在 Telegram 上也可以加入我们。

需要合作推广你的 GitHub Repo、Hugging Face 页面、产品发布或网络研讨会吗？请联系我们。