blume
World-class docs for everything you ship. Fast, AI-ready, and zero-config.
What is it?
What it is
A zero-config, AI-ready documentation framework that transforms Markdown and MDX files into production-grade documentation sites.
Why it exists
To provide a fast, high-performance documentation solution that eliminates the need for manual app boilerplate, framework setup, or complex configuration.
Who should use it
Developers, technical writers, and teams who want to quickly create documentation sites from Markdown/MDX files with zero configuration, leveraging Astro under the hood, and who are comfortable with Node.js and optional TypeScript configuration.
Who should avoid it
Users who need full low-level control over the site generator from the start, those who dislike TypeScript, projects requiring a different frontend framework, or environments that cannot meet the Node.js 22.12+ requirement.
How it works
A quick walkthrough in plain English
How blume works
Step 1 of 3
You interact with it
Open blume, send a request, or connect it to your stack.
Features
Advantages
- High performance via Astro and Vite with minimal client-side JS
- Extremely low barrier to entry (no boilerplate required)
- Highly customizable through component overrides and Tailwind v4
- Scalable from simple static sites to server-side rendered apps
- Strong developer experience with type-safe config and CLI tools
Disadvantages
- Requires Node.js 22.12 or newer
- Abstraction layer (hidden Astro project) may add complexity for advanced debugging before ejection
Installation
cloud
not mentioned
docker
not mentioned
native
npx blume init
compose
not mentioned
FAQ
What are the minimum system requirements to run Blume?
Blume requires Node.js version 22.12 or newer. It is compatible with all major package managers including npm, yarn, pnpm, and Bun.
How do I start a new documentation project?
To start, run `npx blume init` in your project directory. Once initialized, you can start a development server with hot reload by running `blume dev`.
Can I use a framework other than Astro with Blume?
Blume uses Astro under the hood to drive the site, but it is zero-config and manages the Astro project for you. If you want full control and want to manage the framework yourself, you can run `blume eject` to turn the project into a standalone Astro app.
Does Blume support search functionality?
Yes. Blume includes local search using Orama by default. You can also easily switch to other services like FlexSearch, Pagefind, Algolia, Typesense, or Mixedbread via a single setting.
How do I deploy my Blume documentation site?
Running `blume build` generates static HTML in a `dist/` folder, which can be deployed to any static host like Vercel, Netlify, Cloudflare Pages, or GitHub Pages. For server-side features, you can use adapters for Vercel, Netlify, Node, or Cloudflare.
What kind of content formats does Blume support?
Blume is designed to work with Markdown (.md) and MDX (.mdx) files. It also supports mixing local files with remote content sources like GitHub Releases, Notion, or Sanity.
Featured in Videos
YouTube tutorials and walkthroughs for blume
Alternatives
Similar projects ranked by category, topics, and text overlap.
