haydenbleasel/blume
The open-source docs framework for humans and agents.
它解决了什么问题
Blume 是一个零配置的文档框架,让开发者能将 Markdown 或 MDX 文件的文件夹转换为可上线的产品文档网站。它省去了编写应用样板或管理复杂框架设置的需求,同时保持足够的灵活性,让用户可以退出并转为独立的 Astro 项目以获得完全控制。
它的运作方式
Blume CLI 会将内容扫描成图谱,并在 .blume/ 目录中生成一个隐藏的 Astro 项目。此项目由 CLI 驱动,用于开发与构建。Astro 通过一个通配页面来渲染网站,该页面使用 Blume 的内置组件与生成的数据。用户可以将网站部署为静态 HTML,或使用服务器适配器来实现如 AI 助手等请求时功能。
适用对象
希望快速建立具备 AI 功能的文档网站,但不想管理框架的开发者与技术写作者,同时也希望系统能提供自定义或完全迁移至独立应用的选项。
重点特色
- AI 就绪基础设施:包含
llms.txt与llms-full.txt文件、JSON 文档 API、用于代码代理的托管 MCP 服务器,以及可选的页面内助手。 - 零配置设置:将文档文件夹转换为网站,无需复制起始模板或具备框架知识。
- 丰富的组件库:内置支持卡片、标签页、手风琴、代码组与实时组件预览,无需导入。
- 可扩展的内容来源:支持混合本地文件与远程来源,例如 GitHub Releases、Notion、Sanity 与 Contentful。
- API 参考文档生成:原生将 OpenAPI、AsyncAPI 与 GraphQL 规范渲染为参考页面。
- 代理工具:提供 CLI 命令,让代理能使用本地代理来创建、编写与翻译文档。
相关
- 项目
- 项目
- 项目
- 项目