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.

blodemd new

Create a new blode.md documentation site.

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

blodemd new [directory]

Interactive blodemd new inspects the current directory first:

  • If the current directory is empty, it scaffolds there and prompts for the project slug.
  • If the current directory is not empty, it asks whether to create the docs in a subdirectory or scaffold the current directory.
  • If prompts are skipped with --yes or in a non-interactive environment, it falls back to docs/.

What it creates

If you create the docs in a docs/ subdirectory, blodemd new generates the following file tree:

docs.json
index.mdx

docs.json

The generated configuration uses the hosted Blode.md schema and a single "Getting Started" navigation group. The slug field comes from the slug prompt, --slug, or a derived default. The name field defaults to a title-cased display name based on that slug unless you pass --display-name.

{
  "$schema": "https://blode.md/docs.json",
  "name": "My Project",
  "slug": "my-project",
  "navigation": {
    "groups": [
      {
        "group": "Getting Started",
        "pages": ["index"]
      }
    ]
  }
}

index.mdx

A minimal starter page with a title and placeholder content:

---
title: Welcome
---

Start writing your docs here.

Starter template

Use the starter template when you want a richer first pass with repo hygiene files, agent instructions, and branding assets:

  • .gitignore
  • favicon.svg
  • README.md
  • AGENTS.md
  • CLAUDE.md
  • logo/light.svg and logo/dark.svg
  • images/hero-light.svg, images/hero-dark.svg, and images/checks-passed.svg
  • quickstart.mdx
  • development.mdx
blodemd new --template starter

AGENTS.md links to CLAUDE.md when the local filesystem supports symlinks. The default blodemd new output stays as the minimal two-file scaffold.

Options

FieldTypeDescriptionRequiredDefault
[directory]stringTarget directory to scaffold.Yes"interactive flow depends on the current directory; non-interactive defaults to docs"
--slug <slug>stringProject slug written to docs.json. If omitted, interactive mode prompts and non-interactive mode derives it from the chosen location.Yes—
--name <slug>stringDeprecated alias for `--slug`.Yes—
--display-name <name>stringDisplay name written to docs.json `name`. Defaults to a title-cased version of the slug.Yes—
--template <name>stringScaffold an alternate template. Use "starter" for repo hygiene, helper files, and branding assets.Yes"minimal"
--yesbooleanAccept defaults without prompting.Yesfalse

Examples

blodemd new

Next steps

  1. Review docs.json and change slug if you want a different deployment target or {slug}.blode.md subdomain. Change name if you want a different visible site title.
  2. If you used the starter template, replace the generated helper files and brand assets with project-specific content.
  3. Add more .mdx pages and update the navigation array.
  4. Run blodemd push to deploy.