【免费下载链接】blumeThe open-source docs framework for humans and agents.项目地址https://gitcode.com/gh_mirrors/blum/blume点击查看免费下载Blume是一个开源文档框架docs framework专为人类和 AI Agent 设计把 Markdown/MDX 文件丢进文件夹一条blume init命令即可从零搭建文档网站blume build生成带本地搜索的静态站点无需任何模板或样板代码。本教程带你完成 Blume 新手入门安装、初始化、写第一页、本地预览到生产构建全程约 5 分钟。为什么选择 Blume 文档框架特性说明 零配置一个 docs 文件夹就是一个完整项目无需克隆 starter⚡ 性能优秀基于 Astro Vite 输出静态 HTML默认不加载客户端框架 JS 本地搜索Orama 开箱即用Pagefind、Algolia 等一个适配器切换 AI 就绪内置llms.txt、JSON 文档 API、页内 AI 助手、MCP 服务器 组件库卡片、步骤、选项卡、手风琴等组件无需 importMDX 直接用 国际化/SEO多语言路由、OG 图片、sitemap、robots.txt 全部内置核心原理很简单Blume CLI 扫描你的内容在隐藏的.blume/目录下生成并驱动一个 Astro 项目——你只需要写文档剩下的交给框架架构细节见 How it works。⚠️ 环境要求Node.js 22.19 或更高版本以及一个包含至少一个.md/.mdx文件的内容文件夹。这是全部前置条件。一键安装用 blume init 初始化项目打开终端运行下面这条命令即可npx会自动拉取最新版npm / pnpm / yarn / Bun 均支持npx blume initblume init会交互式询问 4 个问题项目创建位置—— 目标目录文档站名称—— 显示在页头和搜索结果中模板选择内容目录位置—— 通常是docs/回答完它会自动生成最小项目骨架并安装依赖docs/ index.mdx # 你的第一个文档页面 .gitignore # 忽略 node_modules/、.blume/、dist/ blume.config.ts # 类型安全的配置文件 package.json # 含 dev / build / doctor 脚本 提示加--yes可跳过所有提问直接取默认值加--no-install则只写文件不装依赖。完整说明见 Quickstart 官方文档。编写第一页Markdown 即页面每个页面就是带 frontmatter 的 Markdown 文件title和description会自动渲染为页面标题和简介。把下面内容写入docs/index.mdx--- title: Introduction description: Welcome to my docs. --- Welcome! 使用 **Markdown** 和内置组件 —— 无需任何 import :::note Blume 内置 callout、卡片、选项卡、步骤等组件。 :::保存后开发服务器会即时热更新——导航、搜索、页面元数据都会随你新增文件自动推断你只管写网站自动跟上。想调整站点标题、主题色、搜索等选项只需编辑 blume.config.ts 配置文件——它是真正的 TypeScript用defineConfig包裹即可获得编辑器自动补全和类型检查所有字段都有合理默认值全部选项参考 配置文档。本地预览启动 dev 开发服务器进入项目目录启动带热重载的开发服务器npm run dev浏览器打开终端提示的地址一个带导航、搜索、暗色模式的文档站已经跑起来了。改任何.mdx文件页面毫秒级刷新。生产构建一条命令生成静态站点npm run build构建完成后纯静态 HTML、CSS 输出到dist/目录内容物包括✅ 所有文档页的静态 HTML✅ 本地搜索索引默认 Orama✅sitemap.xml与robots.txt✅llms.txt/llms-full.txt供 AI 工具消费✅ 预渲染的 Open Graph 社交卡片部署到任意静态托管构建命令blume build、输出目录dist、Node 22.19——这三个参数直接填入 Vercel、Netlify、Cloudflare Pages 或 GitHub Pages 的设置即可上线无需运行任何服务器部署指南见 02-deployment.mdx。进阶解锁让 AI Agent 读懂你的文档Blume 的名字含义正在于此——为人类和 Agent 服务的文档框架。构建产物天生对 AI 友好 任意.mdURL 可返回原始 Markdown 托管MCP 服务器编码 Agent 可直接搜索、阅读你的文档 可选的页内 AI 助手基于文档内容回答用户提问Blume 还内置 Agent Skills教编码 Agent 帮你搭建、编写和维护文档站——甚至提供blume auditSEO 体检、blume evalAgent 只凭文档答题测试文档质量等命令见 CLI 命令列表。常见问题 FAQQ1一定要 Node 22.19 吗是的最低要求 Node.js 22.19Bun、pnpm、npm、yarn 任意包管理器均可。Q2已有项目的 package.json 会被覆盖吗不会。blume init对已有文件只增不改你只需npm install blume后把dev: blume dev和build: blume build加进 scripts或直接运行npx blume dev。Q3以后想要完全控制权怎么办运行npx blume ejectBlume 会把隐藏运行时弹出成一个独立的 Astro 项目仍使用 blume 包源码位于 packages/blume/src。总结回到最初的时间账blume init约 1 分钟安装→ 写一页 MDX1 分钟→npm run dev预览 →npm run build产出dist/→ 推送到任意静态托管。一个带搜索、SEO、AI 能力的生产级文档网站就此上线。接下来推荐的学习路径配置参考、组件库、发现性指南llms.txt 与 MCP。赞分享【免费下载链接】blumeThe open-source docs framework for humans and agents.项目地址https://gitcode.com/gh_mirrors/blum/blume点击查看免费下载相关推荐GitBook入门教程5分钟快速搭建你的第一个技术文档网站GitBook入门教程5分钟快速搭建你的第一个技术文档网站 想要快速搭建专业的技术文档网站吗GitBook 是一个基于 Git 和 Markdown 的现代前端后端知识管理Docsify入门指南5分钟快速搭建现代化文档网站Docsify入门指南5分钟快速搭建现代化文档网站 Docsify是一款神奇的文档网站生成工具它能帮助你快速创建美观、高效的现代化文档网站无需复杂配置让前端文档开发工具终极指南5分钟搭建你的私有化AI媒体生成助手终极指南5分钟搭建你的私有化AI媒体生成助手 Generative Media Skills是一款强大的多模态AI媒体生成工具它能帮助你轻松创建高质量的图像AI 技能媒体生成人工智能音频AI 应用创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考