Meet Blume: An Open-Source, Zero-Config Documentation Framework That Ships AI-Ready Docs From a Markdown Folder

Hayden Bleasel, an knowledgeable developer from OpenAI, launched Blume, an open-source documentation framework. Blume shipped to npm as model 1.0.3 the identical day. It is so simple as Drop Markdown into a folder and ship a docs web site. No app boilerplate is written or maintained afterward. The challenge is MIT-licensed and open sourced.

What is Blume?

Blume is a command-line instrument paired with a part library for docs. It reads a folder of Markdown or MDX information. From that folder, it produces a production-grade documentation web site. That output ships navigation, search, theming, and Open Graph pictures. Configuration stays optionally available and is added one file at a time. The code is a TypeScript monorepo; the revealed bundle sits at packages/blume. Blume’s personal documentation, beneath apps/docs, is constructed with Blume itself. It requires Node.js 22.12 or newer. It runs with Bun, pnpm, npm, or yarn.

How Blume Works?

Under the floor, Blume generates and drives a hidden Astro challenge. First, the CLI masses blume.config.ts and scans your content material into a graph. Next, it writes an Astro challenge into a .blume/ listing. Astro then renders each web page by a single catch-all route. That route imports Blume’s shipped elements, the generated knowledge, and your overrides. On every run, .blume/ regenerates, and solely modified information are rewritten. As a end result, sizzling reload stays quick throughout modifying. The core theme ships no consumer framework JavaScript. Consequently, pages rating effectively on Core Web Vitals by default. When you want full management, blume eject promotes the runtime into a standalone Astro app. That ejected challenge nonetheless relies on the blume bundle.