Blume is a TypeScript-based docs tool that generates a production-grade docs site from Markdown/MDX with zero-config setup and a hidden Astro project. It supports features like local search, AI-ready options, and a component library.
Collecting history — the radar snapshots this repo daily. The trend line appears after 3 days of data (1 so far).
What it is
Blume is a documentation tool that takes Markdown or MDX content and generates a production-grade docs site with navigation, search, theming, Open Graph images, and a rich component library. It operates by generating and driving a hidden Astro project and offers commands to eject to a standalone Astro app.
How it works
The Blume CLI loads blume.config.ts, scans content into a graph, and generates a hidden Astro project under .blume/ that it drives for dev and build. Astro renders through a catch-all page that imports Blume's components, the generated data, and overrides. The .blume/ directory is regenerated on each run to refresh changes, unless you run blume eject to own the project.
Getting started
- Quickstart notes: Blume requires Node.js 22.12 or newer and a content folder with at least one .md or .mdx file.
- Typical commands:
-
npx blume init -
blume dev -
blume build
-
- It works with any package manager and does not require setting up Astro or Tailwind manually.
Recent releases
- blume@1.0.4 (2026-07-15): Patch Changes — Fix the spacing inside directive callouts (
:::note,:::success, …). The global prose paragraph rule leaks a 1rem margin onto the callout's paragraphs. - blume@1.0.3 (2026-07-13): Patch Changes — Render the Ask AI trigger from the shared header instead of per-page wiring; custom pages built on PageLayout (landing pages) were affected.
- blume@1.0.2 (2026-07-13): Patch Changes — Harden pre-paint inline scripts and route-normalizing regexes against CodeQL-reported issues.
- blume@1.0.1 (2026-07-13): Patch Changes — Declare the blume bin as bin/blume.mjs instead of ./bin/blume.mjs; the leading ./ is redundant for some package managers.
- blume@1.0.0 (2026-07-13): Major Changes — Blume v1.
Traction
- Stars: 684
- Forks: 32
- Open issues: 2
Behind the repo
- Developer/organization: Hayden Bleasel, owner of the repository
Caveats
- License: MIT
- Created: 2026-06-21
- Last push: 2026-07-18
- Language: TypeScript
- Topics: docs, mdx, typescript