blodemd init

Create a starter documentation directory with a docs.json configuration file and an index.mdx page.

Copyblodemd init [dir]

The dir argument defaults to docs if omitted.

What it creates

Running blodemd init generates the following file tree:

docs.json

The generated configuration uses the mint theme and a single "Getting Started" navigation group:

Copy{
  "$schema": "https://docs.blode.md/docs.json",
  "name": "my-project",
  "theme": "mint",
  "colors": {
    "primary": "#0D9373"
  },
  "navigation": {
    "groups": [
      {
        "group": "Getting Started",
        "pages": ["index"]
      }
    ]
  }
}

index.mdx

A minimal starter page with a title and placeholder content:

Copy---
title: Welcome
---

Start writing your docs here.

Options

Examples

Copyblodemd init

Next steps

1. Open docs.json and set name to your project slug. This determines the default {name}.blode.md hostname served by the platform wildcard.
2. Add more .mdx pages and update the navigation array.
3. Run blodemd push to deploy.