@gunta85: 我一直等着有人做出这个东西。文档工具,我全都试过:Astro Starlight → 快但丑…
摘要
Blume 是一个基于 Astro 构建的快速、开源文档工具,能从 Markdown 文件夹生成生产级文档站点,内置 AI 就绪、交互式 API 参考和零配置设置。
查看缓存全文
缓存时间: 2026/07/14 00:01
我一直等待有人做出这样的工具。
文档工具,我全都试过了: Astro Starlight → 快但丑 Mintlify → 好看但贵 Fumadocs → 好看但慢 Blume → 好看、快速,并且基于 Astro 构建。外加 MIT 许可证。
只需指向你的 Markdown 文件夹,它就能自动生成导航、搜索、OG 图片,甚至 llms.txt——所有功能一应俱全。
完全没有应用样板代码。
如果你介意锁定,可以使用 blume eject 将其转换为一个普通的 Astro 项目。
就是它了。这就是我想要的。 https://useblume.dev
Blume —— 快速、AI 就绪、Markdown 优先的文档工具
来源:https://useblume.dev/ 最新版本:v1.0.3 (https://github.com/haydenbleasel/blume/releases)
为你交付的一切,提供世界级的文档。
快速、AI 就绪、零配置。将 Markdown 放进一个文件夹,即可交付生产级文档站点,无需编写或维护应用样板代码。永久免费且开源。
阅读文档 (https://useblume.dev/docs)
查看代码 (https://github.com/haydenbleasel/blume)
开箱即用。
生产级文档站点所需的一切 —— 零配置设置、AI、组件库、搜索、SEO 和国际化 —— 无需安装插件或连接任何服务。
零配置,甚至连模板都省了
一个 Markdown 文件夹就是一个完整的项目 —— 无需克隆启动模板,也无需与上游保持同步。
- 导航根据你的文件自动推断
- 搜索、主题和 OG 图片默认开启
- 仅在需要时进行配置
交互式 API 参考
放入 OpenAPI 或 AsyncAPI 规范,Blume 即可渲染出完整的交互式参考文档 —— 包含端点、模式以及在线调试区。
- 支持 OpenAPI 和 AsyncAPI 规范
- 交互式“试一试”调试区
- 基于 Scalar,主题自动匹配
内置变更日志
将每个版本写成一个 Markdown 条目 —— 或者让 Blume 指向你的 GitHub Releases —— 所有版本会自动汇总到 /changelog 的时间线中。
- 时间线页面和永久链接,最新优先
- 直接从 GitHub Releases 获取条目
- RSS feed 默认开启
内置组件
30 多个无障碍组件和一组精选的 Markdown 扩展,可在任何 .mdx 页面中使用,无需导入。
- 标注、卡片、步骤、标签和文件树
- 包安装标签和代码组
- Mermaid 图表和 KaTeX 数学公式
默认即生产就绪
从个人项目到拥有数千页面的站点,搜索、SEO 和国际化均可扩展。
- 开发和生产环境下的本地搜索
- OG 图片、站点地图、RSS 和 JSON-LD
- 支持 36 种语言环境,完全支持从右到左
拥有超能力的 Markdown。
指令变成标注,包名变成安装标签,围栏代码块自动高亮 —— 无需导入,无需管理 JSX。
内容来自任何地方。
Blume 默认读取一个 Markdown 文件夹 —— 但内容也可以来自远程仓库、CMS 或任何自定义后端。可将多个来源混合到一个站点中;它们都通过相同的组件进行渲染。
需要其他后端?一个 custom 源适配器可连接任何 CMS,而无需其 SDK 接触核心代码。
了解内容源 (https://useblume.dev/docs/content/sources)
为人类和模型而构建。
你的 Markdown 既是给读者看的,也是给机器看的。每个页面都可以是原始 Markdown,总结在 llms.txt 中,页面内可回答,并通过 MCP 连接 —— 无需任何额外配置。
内置 llms.txt
一个标志即可生成机器可读的索引和完整语料库,使编码代理和聊天助手能够读取整个站点。
每个 URL 都对应 Markdown
在任何页面的 URL 后加上 .md 即可获取其原始源码 —— 非常适合 LLM 和“复制为 Markdown”的工作流程。每个页面,无论是开发环境还是生产环境,无需配置。
复制或直接在聊天中打开
每个页面均可复制为 Markdown,或直接在 ChatGPT、Claude、v0 等工具中打开 —— 并预填充为回答有关该页面问题所需的内容。
你加入了优秀的行列。
众多公司和开源库正在将它们的文档迁移到 Blume。
- https://files-sdk.dev/
- https://www.ultracite.ai/
- https://batchwork.dev/
- https://infra-ts.dev/
你需要的每个组件。
一套无障碍、可主题化的组件 —— 卡片、步骤、标签、代码组、差异对比等 —— 可在任何 .mdx 页面中使用,无需导入。
- 卡片与卡片组 (Card & CardGroup):带图标的链接卡片,响应式网格布局 (https://useblume.dev/docs/content/components#card-and-cardgroup)
- 步骤 (Steps):用于顺序指令的编号序列 (https://useblume.dev/docs/content/components#steps)
- 标签 (Tabs):在原地切换等效内容 (https://useblume.dev/docs/content/components#tabs)
- 徽章 (Badge):用于状态和元数据的内联标签 (https://useblume.dev/docs/content/components#badge)
- 文件树 (File tree):从 Markdown 列表渲染项目布局 (https://useblume.dev/docs/content/components#file-tree)
- 手风琴 (Accordion):在带边框的容器内堆叠的可折叠面板 (https://useblume.dev/docs/content/components#accordion)
- 可展开 (Expandable):用于详细信息的轻量级内联内容展示 (https://useblume.dev/docs/content/components#expandable)
- 列 (Columns):将块布局在响应式列网格中 (https://useblume.dev/docs/content/components#columns)
- 代码组 (CodeGroup):将代码块分组为标签切换器 (https://useblume.dev/docs/content/components#codegroup)
- 框架 (Frame):居中并添加标题的图像或视觉效果 (https://useblume.dev/docs/content/components#frame)
- 树 (Tree):带有可展开文件夹的层级结构 (https://useblume.dev/docs/content/components#tree)
- 面板 (Panel):用于旁注内容的带标题容器 (https://useblume.dev/docs/content/components#panel)
- 工具提示 (Tooltip):悬停时显示定义或提示 (https://useblume.dev/docs/content/components#tooltip)
- 磁贴 (Tile):以视觉元素为先导的可点击预览 (https://useblume.dev/docs/content/components#tile)
- 提示 (Prompt):带复制按钮的可复制提示 (https://useblume.dev/docs/content/components#prompt)
- 可见性 (Visibility):按受众显示或隐藏内容 (https://useblume.dev/docs/content/components#visibility)
- 类型表格 (Type tables):记录对象的属性、类型和默认值 (https://useblume.dev/docs/content/components#type-tables)
- GitHub 信息 (GitHub info):显示实时星标和 fork 数的仓库卡片 (https://useblume.dev/docs/content/components#github-info)
- 组件 (Component):示例的实时预览,旁边是其源码 (https://useblume.dev/docs/content/components#component)
- 代码块 (CodeBlock):在围栏代码无法使用的地方使用 Shiki 高亮代码 (https://useblume.dev/docs/content/components#codeblock)
- 差异对比 (Diff):Git 风格的语法高亮差异对比 (https://useblume.dev/docs/content/components#diff)
浏览所有组件 (https://useblume.dev/docs/content/components)
使用 Blume 升级你的文档
立即安装,几分钟内即可交付生产级文档站点。
Hayden Bleasel (@haydenbleasel): 隆重推出 Blume 🪷
一个为你交付的一切提供世界级文档的框架。将 Markdown 放入文件夹,即可交付一个完整的文档站点,无需任何应用样板代码。
→ 零配置设置 → 自动 SEO 和 AEO(AI 引擎优化) → 30 多个组件 → 基于 Astro + Vite → 开源,永久免费
相似文章
Blume
Blume 是一个为开发者设计的AI就绪、Markdown优先的文档框架。
Browzer
Browzer通过连接GitHub仓库自动化技术内容创作,草拟文档、指南和SEO友好的博客文章,旨在让DevRel团队能够专注于社区活动。
构建了 Kapa.ai 的免费开源替代品
LiveDocs 是一个开源、自托管的聊天框,能够同时利用结构化文档和实际代码库来回答文档相关问题,并引用精确的文件位置,从而避免过时或缺失的答案。
DocsAlot
DocsAlot 是一款为人类和 AI 系统设计的文档工具。
Astro 7.0
Astro 7.0 是一个主要版本,专注于速度提升,具备 Rust 编译器、基于 Rust 的 Markdown/MDX 处理、基于队列的渲染引擎、Vite 8 及 Rolldown 打包器、路由缓存以及 AI 开发增强功能。