Markdown 优先 · 构建于 Astro 与 Vite

面向人类与
智能体的开源文档框架

把 Markdown 或 MDX 文件丢进文件夹,启动开发服务器,就能得到一个生产级的文档站点 —— 导航、搜索、主题、Open Graph 图片,以及一整套组件库。无需编写或维护任何应用样板。

终端
$ npx blume init
  正在生成 docs/index.mdx 与 blume.config.ts …
✓ 就绪,运行 npm run dev
  • 0需要配置的样板文件
  • 0 KB核心主题的客户端框架 JS
  • 63中文文档页面
  • MIT永久免费且开源

为什么选择 Blume

框架本身就是模板

一些文档工具在你写下第一个字之前就先塞给你一整份代码库。另一些围绕你的内容搭建模板,却把你锁死在它们的托管服务里。Blume 两者都取:你唯一需要碰的就是内容本身。

工作原理

一个文件夹,就是一个完整项目

Blume 命令行加载 blume.config.ts,把内容扫描成一张图,并在 .blume/ 下生成一个隐藏的 Astro 项目,由它在开发与构建时驱动。

这个运行时是实现细节 —— 你写 Markdown,剩下的交给 Blume —— 直到你执行 blume eject 并亲手接管它。

了解自定义与 eject
你的项目
  • docs/
  • index.mdx
  • quickstart.md
  • content/
  • components.mdx
  • blume.config.ts
  • package.json
  • 导航
  • 本地搜索索引
  • 主题与 OG 图片
  • llms.txt / MCP
  • 站点地图与 RSS
  • dist/ 静态站点

开箱即用

特性

一个文档文件夹就是一个完整的项目。每一项都有合理的默认值,配置是你伸手去取的东西,而不是你的起点。

命令行

全部命令,一处查完

通过包管理器运行 npx blume <命令>,或写进 package.json 脚本。

命令说明
blume init [dir]搭建项目(默认交互式)
blume dev启动带热重载的开发服务器
blume build构建静态(或服务端)站点
blume preview预览上一次构建的结果
blume add <item>从注册表安装一个源组件
blume sync重新拉取远程内容来源并重新生成
blume eject将运行时提升为独立的 Astro 应用
blume check用 astro check 对文档站点做类型检查
blume validate校验内部链接、锚点、资源与外部链接
blume doctor诊断配置与内容问题
blume audit审计已构建站点在 SEO 与健康度方面的问题
blume eval由智能体仅依据文档回答你的问题
blume translate用本地智能体 CLI 翻译成已配置的语言区域
blume version [id]把当前文档冻结为一个归档版本
blume migrate [source]借助 Claude Code 或 Codex 迁移到 Blume
blume upgrade升级到新的大版本

部署

blume build 产出静态 HTML

输出到 dist/,可部署到任意静态托管:Vercel、Netlify、Cloudflare Pages、GitHub Pages、S3 + CloudFront 或任意 CDN。需要请求期特性(助手、MCP 服务器)时,在配置里指定托管适配器即可切换为服务端输出。

import { defineConfig } from "blume";
import { vercel } from "blume/deploy";

export default defineConfig({
  deployment: vercel(),
});

托管适配器

  • vercel()Vercel
  • netlify()Netlify Functions
  • node()自托管的 Node 服务器、容器
  • cloudflare()Cloudflare Workers 与 Pages

适配器永远不会被自动探测,必须在 blume.config.ts 中显式指定。

兼容性

  • Node22.12+
  • 包管理器Bun、pnpm、npm、yarn
  • 适配器Vercel、Netlify、Node、Cloudflare

文档

从这里开始读

开始

从零到上线,只需要几分钟。

内容

文件如何变成页面,导航如何自动推导。

内容来源

把远程 Markdown、CMS 与 Obsidian 仓库混进同一个站点。

配置

blume.config.ts 里的每一项功能开关。

可发现性

让搜索引擎、社交平台与编程智能体都能找到你。

API 参考

把规范文件渲染成原生参考页面。

命令行

每一个 blume 命令、参数与用法。

进阶

脱离默认形态的玩法。

把 Markdown 丢进去,站点就出来了

需要 Node.js 22.12 或更高版本,以及一个至少包含一个 .md 或 .mdx 文件的内容文件夹。除此之外没有任何需要配置的东西。