Skip to content
Blode.md

AI agents: fetch the documentation index at llms.txt. Markdown versions are available by appending .md to any page URL, including this page's markdown.

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.

Prerequisites

You need Node.js 24.x.

Steps

Install the CLI
Install
npm i -g blodemd
Authenticate
blodemd login

This opens your browser for OAuth authentication. Use blodemd login --token to paste an API key instead.

Scaffold your docs
blodemd new

In a non-empty repo, the CLI recommends creating a docs/ subdirectory. Choosing that path creates:

docs.json
index.mdx

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.

Review your project slug

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"] }]
  }
}
Deploy
blodemd push docs

Your docs are live at your-slug.blode.md.

What's next