Blume: Framework tài liệu mã nguồn mở, không cần cấu hình, tối ưu cho AI

Hayden Bleasel, một chuyên gia phát triển tại OpenAI, đã ra mắt Blume, một framework tài liệu mã nguồn mở. Blume được phát hành lên npm dưới phiên bản 1.0.3 ngay trong cùng ngày. Cách sử dụng đơn giản như việc thả các tệp Markdown vào một thư mục và xuất bản trang tài liệu. Không cần phải viết hay duy trì bất kỳ mã boilerplate ứng dụng nào sau đó. Dự án này được cấp phép theo MIT và là mã nguồn mở.

Blume là gì?

Blume là một công cụ dòng lệnh (CLI) kết hợp với thư viện thành phần dành cho tài liệu. Nó đọc một thư mục chứa các tệp Markdown hoặc MDX. Từ thư mục đó, nó tạo ra một trang tài liệu đạt chuẩn sản xuất. Đầu ra bao gồm điều hướng, tìm kiếm, giao diện và hình ảnh Open Graph. Cấu hình là tùy chọn và được thêm vào từng tệp một. Mã nguồn là một TypeScript monorepo; gói được xuất bản nằm tại packages/blume. Bản thân tài liệu của Blume, nằm trong thư mục apps/docs, cũng được xây dựng bằng chính Blume. Nó yêu cầu Node.js 22.12 trở lên và chạy được với Bun, pnpm, npm hoặc yarn.

Blume hoạt động như thế nào?

Bên dưới bề mặt, Blume tạo và vận hành một dự án Astro ẩn. Đầu tiên, CLI tải blume.config.ts và quét nội dung của bạn vào một đồ thị. Tiếp theo, nó ghi một dự án Astro vào thư mục.blume/. Sau đó, Astro hiển thị mọi trang thông qua một tuyến đường catch-all duy nhất. Tuyến đường đó nhập các thành phần của Blume, dữ liệu đã tạo và các tùy chỉnh của bạn. Mỗi lần chạy, thư mục.blume/ được tạo lại và chỉ những tệp thay đổi mới được ghi đè. Nhờ đó, tính năng hot reload vẫn hoạt động nhanh chóng trong quá trình chỉnh sửa. Giao diện cốt lõi không chứa JavaScript của framework phía client. Kết quả là các trang đạt điểm số cao trên Core Web Vitals theo mặc định. Khi bạn cần toàn quyền kiểm soát, lệnh blume eject sẽ nâng cấp runtime thành một ứng dụng Astro độc lập. Dự án đã tách ra đó vẫn phụ thuộc vào gói blume.

Bắt đầu

Việc thiết lập chỉ mất một lệnh duy nhất, vì vậy quá trình làm quen rất nhanh chóng.

Sau đó, blume dev khởi chạy một máy chủ hỗ trợ hot-reloading. Trong khi đó, blume build ghi các tệp HTML tĩnh và chỉ mục tìm kiếm cục bộ vào thư mục dist/. Tệp cấu hình là TypeScript thực thụ, được xác thực bởi một schema.

Vì cấu hình có kiểu dữ liệu (typed), các trình soạn thảo sẽ phát hiện lỗi trước khi quá trình build chạy. CLI bao quát toàn bộ vòng đời ngoài những điều cơ bản đó:

Sẵn sàng cho AI ngay từ thiết kế

Ngoài độc giả là con người, Blume còn nhắm đến các tác nhân (agents). Mỗi trang sẽ trả về Markdown thô khi bạn thêm.md vào URL của nó. Một flag đơn lẻ sẽ xuất ra tệp llms.txt và llms-full.txt cho các tác nhân. Mỗi trang có thể được sao chép dưới dạng Markdown hoặc mở trong ChatGPT, Claude hoặc v0. Một trợ lý Ask AI tùy chọn trong trang sẽ trả lời trực tiếp các câu hỏi của người đọc. Nó chạy trên AI SDK thông qua Vercel AI Gateway, OpenRouter, Inkeep hoặc bất kỳ endpoint nào tương thích với OpenAI. Blume cũng có thể lưu trữ một máy chủ Model Context Protocol (MCP). Thông qua đó, Claude Code, Cursor và VS Code có thể đọc tài liệu trực tiếp.

Máy chủ đó cung cấp bốn công cụ chỉ đọc: search_docs, get_page, list_pages và get_navigation.

Các trường hợp sử dụng kèm ví dụ

Những khả năng này tương ứng với các công việc cụ thể. Đối với một sản phẩm API, hãy thả vào một thông số kỹ thuật OpenAPI hoặc AsyncAPI. Blume sau đó sẽ hiển thị một tài liệu tham khảo tương tác với các schema, xác thực và trình chơi thử yêu cầu (request playground) thông qua Scalar. Đối với một thư viện, hãy hướng Blume đến các GitHub Releases của bạn. Mỗi bản phát hành sẽ được tổng hợp thành một dòng thời gian thay đổi (changelog) với nguồn cấp dữ liệu RSS. Đối với khán giả toàn cầu, hãy thêm các tệp đã dịch theo từng ngôn ngữ. Blume hỗ trợ 36 ngôn ngữ, định tuyến theo ngôn ngữ và bố cục từ phải sang trái. Đối với nội dung hỗn hợp, hãy kết hợp các tệp cục bộ với MDX từ xa, Notion hoặc Sanity. Tất cả các nguồn đều hiển thị thông qua cùng một thành phần.

Giới thiệu Blume 🪷

Một framework tài liệu đẳng cấp thế giới cho mọi thứ bạn xuất bản. Thả Markdown vào một thư mục và xuất bản một trang tài liệu đầy đủ mà không cần boilerplate ứng dụng.

→ thiết lập không cần cấu hình → tự động SEO và AEO → hơn 30 thành phần → được hỗ trợ bởi astro + vite → mã nguồn mở, miễn phí mãi mãi pic.twitter.com/fQSwLd9BM9

So sánh Blume

Để có cái nhìn tổng quan, dưới đây là Blume so với ba phương pháp tài liệu phổ biến. Các tính năng thay đổi nhanh chóng, vì vậy hãy xác minh thông tin hiện tại trước khi áp dụng.

Điểm mạnh và Điểm yếu

Điểm mạnh

Điểm yếu

Những điểm chính cần lưu ý

Hãy xem qua GitHub Repo. Ngoài ra, đừng ngần ngại theo dõi chúng tôi trên Twitter và đừng quên tham gia SubReddit 150k+ ML của chúng tôi cũng như đăng ký nhận Bản tin. Khoan đã! Bạn có dùng Telegram không? Bây giờ bạn cũng có thể tham gia cùng chúng tôi trên Telegram.

Bạn cần hợp tác với chúng tôi để quảng bá GitHub Repo HOẶC Trang Hugging Face HOẶC Bản phát hành sản phẩm HOẶC Hội thảo trực tuyến, v.v.? Hãy kết nối với chúng tôi.