Blume：一個開源、零配置的文件框架，從Markdown資料夾生成AI就緒文件

Hayden Bleasel，來自 OpenAI 的專家開發者，釋出了 Blume，一個開源的文件框架。Blume 在當天作為版本 1.0.3 釋出到 npm。它的理念簡單：將 Markdown 放入資料夾，然後交付一個文件站點。無需編寫或維護任何應用樣板程式碼。該專案採用 MIT 許可並開源。

什麼是 Blume？

Blume 是一個命令列工具，配有一個用於文件的元件庫。它讀取一個 Markdown 或 MDX 檔案資料夾，從中生成一個生產級文件站點。該輸出包含導航、搜尋、主題和 Open Graph 影像。配置保持可選，可逐個檔案新增。程式碼是一個 TypeScript monorepo；釋出的包位於 packages/blume。Blume 自身的文件位於 apps/docs，由 Blume 自身構建。它需要 Node.js 22.12 或更高版本。支援 Bun、pnpm、npm 或 yarn 執行。

Blume 如何工作？

在表面之下，Blume 生成並驅動一個隱藏的 Astro 專案。首先，CLI 載入 blume.config.ts 並將內容掃描成圖譜。接著，它將一個 Astro 專案寫入 .blume/ 目錄。然後 Astro 透過一個單一的 catch-all 路由渲染每個頁面。該路由匯入 Blume 附帶的元件、生成的資料以及你的覆蓋項。每次執行時，.blume/ 重新生成，且僅重寫更改的檔案。因此，編輯期間熱過載保持快速。核心主題不運送客戶端框架 JavaScript。因此，頁面預設在 Core Web Vitals 上得分良好。當你需要完全控制時，blume eject 將執行時提升為獨立的 Astro 應用。該專案仍然依賴於 blume 包。

快速開始

設定只需一條命令，因此上手很快。

npx blume init

之後，blume dev 啟動一個熱過載伺服器。同時，blume build 將靜態 HTML 和本地搜尋索引寫入 dist/。配置檔案是真實的 TypeScript，由 schema 驗證。

// blume.config.ts import { defineConfig } from "blume";

export default defineConfig({ content: { sources: [ { type: "filesystem", root: "docs" }, { type: "notion", database: process.env.NOTION_DB }, ], }, });

由於配置有型別，編輯器能在構建前捕捉錯誤。CLI 涵蓋基本命令之外的完整生命週期。

AI 就緒的設計

除了人類讀者，Blume 也面向 AI 代理。每個頁面在 URL 後新增 .md 時返回原始 Markdown。一個標誌即可為代理生成 llms.txt 和 llms-full.txt。每個頁面可複製為 Markdown 或在 ChatGPT、Claude 或 v0 中開啟。可選的內頁 Ask AI 助手直接回答讀者問題。它執行在 AI SDK 上，透過 Vercel AI Gateway、OpenRouter、Inkeep 或任何相容 OpenAI 的端點。Blume 還可以託管 Model Context Protocol (MCP) 伺服器。透過它，Claude Code、Cursor 和 VS Code 直接讀取文件。

Claude MCP 新增命令示例： claude mcp add --transport http your-docs https://docs.example.com/mcp

該伺服器暴露四個只讀工具：search_docs、get_page、list_pages 和 get_navigation。

用例示例

這些能力對應具體任務。對於 API 產品，放入 OpenAPI 或 AsyncAPI 規範。Blume 然後渲染互動式參考，包含 schema、認證和透過 Scalar 的請求測試。對於庫，將 Blume 指向 GitHub Releases。每個釋出彙總到帶有 RSS 源的生成變更日誌時間線。對於全球受眾，按語言新增翻譯檔案。Blume 支援 36 種語言、語言感知路由和從右到左佈局。對於混合內容，結合本地檔案與遠端 MDX、Notion 或 Sanity。所有源透過相同元件渲染。

全球最佳文件框架簡介

一個適合你所有交付的世界級文件框架。將 Markdown 放入資料夾，無需應用樣板程式碼即可交付完整文件站點。→ 零配置設定 → 自動 SEO 和 AEO → 30+ 元件 → 由 Astro + Vite 驅動 → 開源，永久免費。

比較

為了背景，這裡將 Blume 與三種常見文件方法對比。功能變化很快，因此在你採用前請驗證當前細節。

表格略（翻譯時保留比較維度）

優勢和劣勢

優勢：零配置啟動；靜態優先輸出無核心客戶端 JS；內建 AI 表面；型別安全配置；可提升為獨立 Astro 應用減少長期鎖定。

劣勢：版本 1.0.3 較新，生態系統尚在初期；需要 Node.js 22.12+；請求時功能需要伺服器介面卡；自託管需要自行處理分析和助手；第三方整合少於成熟託管平臺。

關鍵要點

Blume 將 Markdown 資料夾變成零配置的生產級文件站點。它驅動隱藏的 Astro 和 Vite 專案，並可提升為獨立 Astro。AI 功能內建：llms.txt、每頁 Markdown 和 MCP 伺服器。MIT 許可，需要 Node.js 22.12+。早期採用者包括從 Mintlify 遷移的 Quiver 和 Neon 的 add-mcp 文件。

檢視 GitHub 倉庫。也歡迎關注我們的 Twitter，別忘了加入我們的 150k+ML SubReddit 和訂閱我們的通訊。在 Telegram 上也可以加入我們。

需要合作推廣你的 GitHub Repo、Hugging Face 頁面、產品釋出或網路研討會嗎？請聯絡我們。