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 or later.
npm install -g blodemdblodemd loginThis opens your browser for OAuth authentication. You can also use an API key with blodemd login --token.
blodemd init docsThis creates a docs/ directory with a starter docs.json and index.mdx:
Open docs/docs.json and set name to your project slug. This determines your subdomain:
{
"name": "my-project",
"theme": "mint",
"colors": { "primary": "#0D9373" },
"navigation": {
"groups": [{ "group": "Getting Started", "pages": ["index"] }]
}
}blodemd push docsYour docs are live at my-project.blode.md.