whatisgithub

What is blume?

haydenbleasel/blume — explained in plain English

Analysis updated 2026-05-18

889TypeScriptAudience · developerComplexity · 2/5LicenseSetup · easy

In one sentence

A zero-config tool that turns a folder of Markdown files into a fast, searchable documentation website built on Astro.

Mindmap

mindmap
  root((Blume))
    What it does
      Markdown to docs site
      Zero config setup
      AI ready docs
    Tech stack
      TypeScript
      Astro
      MDX
    Use cases
      Product documentation site
      Team knowledge base
      AI searchable docs
    Audience
      Developers
      Teams

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

What do people build with it?

USE CASE 1

Turn a folder of Markdown files into a documentation website with no app boilerplate.

USE CASE 2

Add local or AI powered search to a docs site.

USE CASE 3

Render an OpenAPI spec as an interactive API reference.

USE CASE 4

Let a coding agent read and search the documentation directly through a hosted MCP server.

What is it built with?

TypeScriptAstroMDXNode.js

How does it compare?

haydenbleasel/blumeai4s-research/open-sciencesilvertakana/worldwideview
Stars889880874
LanguageTypeScriptTypeScriptTypeScript
Setup difficultyeasymoderatemoderate
Complexity2/53/54/5
Audiencedeveloperresearcherdeveloper

Figures from each repo's GitHub metadata at analysis time.

How do you get it running?

Difficulty · easy Time to first run · 5min

Requires Node.js 22.12 or newer, works with npm, pnpm, yarn, or Bun.

MIT license, meaning free use, modification, and distribution with attribution.

So what is it?

Blume is a tool for turning a folder of Markdown or MDX files into a full documentation website with almost no setup. You point it at a folder of content, run one command to start a dev server, and it gives you navigation, search, page theming, social share images, and a library of ready made components, without writing any application code yourself. Behind the scenes, Blume generates and manages a hidden Astro project on your behalf, so you never have to configure Astro or a CSS framework directly. If you later want full control over that generated project, a single command called eject converts it into a standalone Astro app that still depends on the Blume package. The output of a normal build is static HTML, which can be hosted on almost any static hosting service, though switching to a server based deployment unlocks features that need to respond to requests live, such as an AI powered search assistant. Configuration files are written in real TypeScript and checked against a schema, so mistakes get caught by your editor before you even build the site. The component library covers common documentation needs like tabs, code groups, file trees, and step by step instructions, all usable directly inside MDX pages without manual imports. Search runs locally by default using a library called Orama, though it can be swapped for other search providers with a single setting. Blume also pays specific attention to being usable by AI systems and coding agents, offering raw Markdown versions of every page, a hosted server that lets agents search and read the docs, and bundled skills that teach a coding agent how to write and maintain a docs site built with Blume. Getting started requires Node.js 22.12 or newer and works with npm, pnpm, yarn, or Bun. The project itself is a monorepo containing both the published package and its own documentation site, which is built using Blume itself. It is released under the MIT license and is aimed at developers and teams who want a documentation site without maintaining a custom application for it.

Copy-paste prompts

Prompt 1
Help me scaffold a new documentation site using blume init.
Prompt 2
Show me how to run and preview a Blume docs site locally.
Prompt 3
Explain how to configure blume.config.ts for my project.
Prompt 4
Help me deploy a Blume static build to Cloudflare Pages.
Prompt 5
Walk me through using blume eject to get a standalone Astro project.

Frequently asked questions

What is blume?

A zero-config tool that turns a folder of Markdown files into a fast, searchable documentation website built on Astro.

What language is blume written in?

Mainly TypeScript. The stack also includes TypeScript, Astro, MDX.

What license does blume use?

MIT license, meaning free use, modification, and distribution with attribution.

How hard is blume to set up?

Setup difficulty is rated easy, with roughly 5min to a first successful run.

Who is blume for?

Mainly developer.

Open on GitHub → Ask about another repo

This repo across BitVibe Labs

Verify against the repo before relying on details.