ByteNoteByteNote
Blume:把 AI 就绪做成默认值的文档框架

字节笔记本

2026年8月24日

Blume:把 AI 就绪做成默认值的文档框架

API中转
¥120

给产品建文档站的框架一抓一大把,Docusaurus、Starlight、Nextra 各有各的好。Blume 切的角度不太一样:它把「AI 怎么读你的文档」做成了框架的默认能力:llms.txt 默认生成,任意页面可以直接吐 Markdown,能一键带 Ask AI 问答和 MCP 服务器,甚至有个命令用 AI 代理来测试你的文档到底能不能回答用户的问题。两个月 1300 多 stars,值得看看它这套 AI 就绪的设计。

项目简介

Blume 是个 Markdown 优先的开源文档框架,作者 haydenbleasel,MIT 协议,底层是 Astro + Vite,页面写 MDX,样式 Tailwind,配置集中在 blume.config.ts。static-first,构建时读内容,也能加 adapter 走服务端渲染。官网口号是「Fast, AI-ready, and zero-config down to the template」。

框架本体的功能是完整的一套:文件路由自动推断侧边栏和大纲、一组内置文档组件(步骤、标签页、类型表格、diff 等)、多内容源混用(本地文件、远程仓库、自定义后端)、i18n、版本快照、无 API key 的客户端搜索、PDF/EPUB 导出、OpenAPI 和 AsyncAPI 规格直接生成 API 参考页。作为文档框架它合格,但这些不是它被关注的原因。

AI 就绪是默认值

Blume 的 AI 能力分三层,开箱程度不同:

llms.txt,默认开启。 构建时自动生成 /llms.txt(站点索引,按侧边栏结构组织)和 /llms-full.txt(全部页面的 Markdown 正文)。不想要,配置一行 ai.llmsTxt: false 关掉;个别页面不想进,frontmatter 里写 ai.exclude: true

Ask AI 与 MCP 服务器,手动开启。 页内问答助手和托管 MCP 服务都是 opt-in,不开的话构建产物完全是静态的。

有意思的是它生成的「发现文件」全家桶:agent-readability.json 汇总所有 AI 面板;/.well-known/mcp.json 按 SEP-2127 Server Card 规范发布 MCP 信息;/.well-known/api-catalog 遵循 RFC 9727;/.well-known/agent-skills/index.json 做技能发现;还有 Web Bot Auth 的公钥目录和 DNS-AID 记录(这个要自己去 DNS 服务商加)。这几样都是近一年冒出来的 agent 时代标准,Blume 一个框架全给实现了,冲这个「AI 就绪」的含金量也不虚。

每个页面都是 Markdown

内容协商做得细。任意 URL 加 .md 后缀返回降级后的纯 Markdown——TypeTable 变表格、Callout 变引用块、Steps 变有序列表,组件语义不丢;加 .mdx 拿原始源码。也可以带 Accept: text/markdown 请求头访问原地址,同一个 URL 人看 HTML、agent 拿 Markdown。响应还带 x-markdown-tokens 头标注 token 量,方便 agent 控制上下文预算。

Ask AI 与 MCP

Ask AI 的问答不是外包给某个 SaaS,后端可以选内置 gateway(配一个 AI_GATEWAY_API_KEY 就行)、OpenRouter、LLM Gateway、Inkeep 或任意 OpenAI 兼容端点。检索参数可调:召回条数、摘录长度、上下文预算。instructions 配置是追加到内置的 grounding 指令上,不会把你调教过的部分冲掉。注意两点:Ask AI 和 MCP 都要求服务端输出(deployment.output: "server"),纯静态部署会构建失败;自建后端时端点默认没鉴权,官方建议自己加限流。

MCP 服务器暴露四个只读工具:search_docsget_pagelist_pagesget_navigation,搜索支持按 frontmatter 的 facets 过滤。Claude Code 用户一行接入:

bash
claude mcp add --transport http my-docs https://docs.example.com/mcp

给 agent 的技能,和反向验证

Blume 自己也吃了 agent 饭:仓库提供官方技能,一条命令装给 Claude Code、Codex 或 Cursor:

bash
npx skills add haydenbleasel/blume

你自己的文档站也能带技能——ai.skills 指向一个目录,SKILL.md 原样发布,带资源的技能打成 .tar.gz 并附 SHA-256 摘要。

最值得单独说的是 blume eval:放一个 AI 代理去读你的文档站,模拟用户提问,检验文档能不能答上来,结果可以当 CI 门禁。「文档写完没人验证有效性」是老问题,让 agent 当第一个读者是个务实的主意。配套还有 blume translate 用 AI 补齐多语言翻译,blume audit 检查 DNS-AID 记录配没配对。

不想给 AI 看?

退出路径齐全:ai.llmsTxt 关索引、ai.exclude 排除单页、ai.openInChat 关「在聊天里打开」按钮、ai.webmcp 退出浏览器端 WebMCP。还有一个通用的兜底:往 public/ 放一个同名文件就能完全接管任何生成产物,Blume 不会覆盖你的文件。草稿页自动不进 llms 文件。

注意事项

  • Ask AI 和 MCP 需要服务端运行,选部署平台时留意;Cloudflare 上要用 runtime binding 而非 process.env
  • 自托管 Ask AI 端点务必加鉴权和限流,官方只做了请求校验
  • 2026 年 6 月才建仓,迭代快,配置项以官方文档为准
  • 和 Docusaurus 这类成熟方案比生态还薄,主题和插件数量有限

项目链接

分享: