Skip to content
Blume
Esc
↑↓navigate↵open⌘Jpreview

Blume vs ReadMe.API docs that live in your repo.

ReadMe is a hosted developer hub with a web editor, API metrics, and personalized docs. Blume builds your guides, changelog, and API reference from files in your repo, free to host anywhere, and an agent moves your hub without breaking a URL.

npx blume migrate readme --codex
Blume and ReadMe at a glance
BlumeReadMe
PriceBlumeFree and open source, with no seat limitsReadMeFree Starter with one admin; Pro from $250 a month with five admins
HostingBlumeAny host: Vercel, Netlify, Cloudflare, Node, or static filesReadMeReadMe's cloud, on *.readme.io or your own domain
EditingBlumeMarkdown and MDX in your repo, in any editorReadMeA web editor, plus two-way sync with GitHub, GitLab, or Bitbucket
AI assistantBlumeAn in-page assistant on the model you choose, billed by your providerReadMeAsk AI Lite on Pro; full Ask AI is a $150-a-month add-on
Agent featuresBlumellms.txt, Markdown mirrors, and a JSON API by default; an opt-in MCP serverReadMellms.txt, Markdown for agents, and an MCP server; its doc search is an add-on
API referencesBlumeOpenAPI, AsyncAPI, and GraphQL, with a Try it playgroundReadMeOpenAPI, Swagger, and Postman with Try It; GraphQL in limited support
VersioningBlumeblume version snapshots with a switcher and scoped searchReadMeVersions with a dropdown; one on Starter, unlimited on Pro
LeavingBlumeblume eject hands you a standalone Astro appReadMePages sync to Git; settings, landing page, and metrics stay in ReadMe

ReadMe details are from its own pages as of October 7, 2026: Pricing, Plans, Ask AI, AI-ready docs, Git sync, OpenAPI. Something out of date? Let us know

Your docs come with you.Your URLs stay flat, and an agent does the move.

Every URL stays flat.
Section folders keep their /docs/ and /reference/ paths, categories become group folders, and nested pages pin their old URL with slug.
The reference rebuilds from your specs.
Each OpenAPI file becomes an openapi() source, endpoint prose moves into an overlay, and every old endpoint URL redirects to its operation page.
A codemod converts the syntax.
Emoji callouts, code tabs, [block:…] JSON, glossary terms, and ReadMe's components become directives, CodeGroup, Tooltip, and Blume components.
Settings come from your hub.
There's no config file in Git, so the agent reads your logo, colors, fonts, and navigation from the settings every hub page embeds.

ReadMe

Blume

  • _order.yamlmeta.ts
  • docs/Getting Started/docs/(Getting Started)/
  • > 📘 Title:::info[Title]
  • doc:quickstart/docs/quickstart
  • <Cards columns><CardGroup cols>
  • <Glossary><Tooltip>
  • excerptdescription

When ReadMe might suit you better.Blume isn't the right fit for every team.

You want a web editor.
ReadMe's editor, with branches, reviews, and multiplayer editing on Pro, lets teammates publish without touching Git. Blume is Markdown and MDX in your repo.
You want docs that know the reader.
With a JWT login, ReadMe shows each developer their own API keys in code samples and Try It, and their recent requests once you send it your API logs.
You want a whole developer hub.
ReadMe adds discussion forums, recipes, a landing page builder, and API usage metrics to the docs. Blume covers the docs, changelog, and API reference, and leaves community and metrics to other tools.
Migrate from
  1. 1

    Run one command in your docs project.

    Using Claude Code? Swap --codex for --claude.

  2. 2

    Review the agent's edits.

    It follows Blume's migration playbook for , rewriting your config and pages in place, so you review the whole move as one diff.

  3. 3

    Preview the result.

    Run npx blume dev, then read the agent's summary of anything it dropped or approximated.

Questions, answered.About moving from ReadMe to Blume.

What's the difference between Blume and ReadMe?

ReadMe is a hosted developer hub with a web editor, API metrics, and logins for personalized docs, from $250 a month on Pro. Blume is a free, open-source framework that builds your guides, changelog, and API reference from files in your repo, and you host it anywhere.

Can I keep my ReadMe pages and URLs?

Yes. npx blume migrate readme --codex runs a bundled codemod that keeps every page at its flat ReadMe URL, converts callouts, code tabs, and ReadMe's components, and redirects every old API reference URL.

What happens to my API reference?

Blume generates it from the OpenAPI files you already sync, with the prose from your endpoint pages, in ReadMe's order. Try it sends requests from the reader's browser, so your API must allow your docs origin, or you turn on Blume's proxy on a server deployment.

What if my hub isn't in Git?

Connect bi-directional sync to a new, empty repository under Settings → Git Connection, and ReadMe writes the whole hub there, with every version as a branch. Then run the migration from that repository.

What doesn't the migration carry over?

ReadMe's hosted features (the editor, branches and reviews, API metrics and request logs, discussions, and the landing page builder), personalized docs with per-reader API keys, login-gated docs, and recipe walkthroughs. The agent reports each one, and Blume's Try it takes the credentials readers type.

Upgrade your docs with Blume.

Install today and ship a production-grade docs site in minutes. Free and open source, forever.

npx blume init