Blume addresses the complexity of shipping production-grade documentation sites by offering a zero-configuration, AI-ready solution. It targets engineers and developers who need fast, maintainable documentation without extensive boilerplate, providing a production-grade site with navigation, search, and theming out-of-the-box.

How It Works

Blume operates via a CLI that drives a hidden Astro project, abstracting away framework setup. It scans Markdown/MDX content into a graph, enabling Astro to render pages using Blume's built-in components and generated data. This approach prioritizes speed and ease of use, delivering static HTML via Vite with minimal client-side JavaScript for excellent Core Web Vitals scores. Configuration is opt-in and type-safe via TypeScript.

Quick Start & Requirements

• Install/Run: Scaffold with npx blume init, run dev server with blume dev, build static site with blume build.
• Prerequisites: Node.js 22.12+ required. A content folder with at least one .md or .mdx file is necessary.
• Links: Official documentation, quickstart guides, and component lists are mentioned but not directly linked in the provided text.

Highlighted Details

• Zero-Config: No starter projects to clone or frameworks to learn; configuration is opt-in.
• Performance: Fast static HTML generation via Astro and Vite, with core theme shipping no client framework JS for optimal Core Web Vitals.
• Type Safety: Configuration files (blume.config.ts, meta.ts) are validated TypeScript.
• Component Library: Includes cards, steps, tabs, code groups, file trees, and live previews usable directly in MDX.
• Search: Integrates with Orama, FlexSearch, Pagefind, Algolia, Typesense, and Orama Cloud.
• AI-Ready: Supports LLM integration via llms.txt, raw Markdown access, and an optional hosted MCP server for coding agents.
• Content Sources: Mixes local files with remote MDX, GitHub Releases, Notion, Sanity, or custom backends.
• Internationalization: Supports locale-aware routing, per-language navigation, and translated UI.
• SEO: Built-in metadata, Open Graph images, sitemap, robots.txt, RSS feeds, and JSON-LD.
• Export: Client-side PDF and EPUB export for pages.
• Customization: Allows component overrides, React islands, custom pages, and Tailwind v4 theming.
• Eject: blume eject command generates a standalone, owned Astro project.

Maintenance & Community

No specific details regarding notable contributors, sponsorships, or community channels (like Discord/Slack) were present in the provided README text.

Licensing & Compatibility

• License: MIT.
• Compatibility: The MIT license permits broad use, including commercial applications and linking within closed-source projects.

Limitations & Caveats

The abstraction layer of the hidden Astro project may require an blume eject for users desiring direct Astro control. A recent Node.js version (22.12+) is mandatory. Advanced AI features might necessitate additional service configurations.