Quickstart
Go from zero to deployed documentation in five minutes.
This guide walks you through installing the CLI, scaffolding a docs project, and deploying it.
You need Node.js 20.17 or later.
npm install -g blodemdblodemd loginThis opens your browser for OAuth authentication. Use blodemd login --token to paste an API key instead.
blodemd newIn a non-empty repo, the CLI recommends creating a docs/ subdirectory. Choosing that path creates:
If you want to scaffold the current directory instead, run blodemd new ..
For a fuller kit with .gitignore, README.md, AGENTS.md, CLAUDE.md, favicon.svg, logo/, and images/, add --template starter.
The scaffold writes both name and slug into docs/docs.json. Change slug later if you want a different subdomain, and change name if you want a different visible site title:
{
"$schema": "https://blode.md/docs.json",
"name": "Acme Docs",
"slug": "acme-docs",
"navigation": {
"groups": [{ "group": "Getting Started", "pages": ["index"] }]
}
}blodemd push docsYour docs are live at your-slug.blode.md.