This week, Blume, an open-source documentation framework developed by OpenAI's Hayden Bleasel, was released as version 1.0.3 on npm. Blume simplifies the process of creating documentation sites by allowing users to drop Markdown files into a folder, which are then transformed into a production-grade site without the need for extensive boilerplate code. The framework is licensed under MIT and is available for free.
Blume is designed as a command-line tool that works with a component library to read Markdown or MDX files from a specified folder. It generates a complete documentation site featuring navigation, search functionality, theming options, and Open Graph images. The framework is built using a TypeScript monorepo, and its own documentation is created using Blume itself. It requires Node.js version 22.12 or newer and is compatible with Bun, pnpm, npm, or yarn.
Technically, Blume operates by generating an Astro project in the background. The command-line interface (CLI) loads a configuration file, scans the content, and writes an Astro project into a hidden directory. This process allows for fast hot reloading during editing. The framework supports a range of commands like 'blume init' for project setup, 'blume dev' for starting a development server, and 'blume build' for creating static HTML outputs.
Blume is targeted at developers who need to create and maintain documentation for APIs, libraries, and other software projects. It supports integration with platforms like GitHub and allows for localization in 36 languages. Use cases include rendering interactive API references and generating changelogs from GitHub releases.
Work implications: Blume could streamline documentation workflows for developers, making it easier to maintain up-to-date and AI-ready documentation, potentially improving productivity and collaboration.
Originally reported by MarkTechPost