Blume
Blume 是一个开源的、以 Markdown 为核心的文档框架,旨在通过零配置设置生成生产级站点,并内置了 AI 功能和交互式 API 参考支持。
Blume 是一个开源的、以 Markdown 为核心的文档框架,旨在通过零配置设置生成生产级站点,并内置了 AI 功能和交互式 API 参考支持。
产品用途与官方定位
Blume 通过允许用户直接从 Markdown 文件发布内容,简化了文档网站的创建过程。它自动处理导航、SEO 和搜索等核心功能,使开发人员能够专注于内容创作,而非繁琐的样板维护。
该平台专为人类读者和机器代理设计,原生支持 llms.txt 和 MCP 服务器等 LLM 友好格式。它提供了一套完整的组件和 CLI 工具集,用于管理文档的整个生命周期。
有官方来源支持的使用场景
为软件项目和开发人员工具创建全面、可搜索且具有交互性的文档站点。
从 OpenAPI 或 AsyncAPI 规范生成交互式 API 参考页面,并内置实时测试沙箱。
官网提供的使用流程
运行 npx blume init 命令,使用必要的配置文件搭建一个新的文档项目脚手架。
将 Markdown 或 MDX 文件放入项目文件夹中,系统将自动生成站点导航和页面结构。
Blume 的设计旨在弥合人类可读文档与机器可访问知识之间的鸿沟。通过自动生成机器可读索引并在每个 URL 提供原始 Markdown 访问,该工具使 AI 模型和编码代理能够准确地解释和利用文档库。
用自己的素材和工作流完成验证
核对了哪些信息以及核对时间
基于已核对产品资料的回答
不需要,Blume 采用零配置设计。一个简单的 Markdown 文件文件夹即可作为一个完整的项目,导航会根据您的文件结构自动推断生成。
可以,Blume 支持多种内容源。您可以配置框架,通过内容源配置从远程仓库、CMS 平台或自定义后端提取内容。
Blume 通过接收 OpenAPI 或 AsyncAPI 规范来支持交互式 API 参考。它将这些规范渲染成包含架构(Schema)和实时“尝试一下”沙箱的文档页面。
是的,Blume 支持多达 36 种语言的国际化,包括对从右至左语言的全面支持,确保您的文档能够覆盖全球用户群。
Blume 内置了 CLI 工具,可自动执行维护任务,例如验证链接、审计 SEO 性能、评估文档质量以及管理翻译更新。