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 name field comes from the slug prompt, --name, or a derived default:

{
  "$schema": "https://blode.md/docs.json",
  "name": "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.

The starter does not generate a LICENSE file. Choose a license explicitly if the repo will be public or open source.

Options

Field	Type	Description	Required	Default
`[directory]`	string	Target directory to scaffold.	Yes	"interactive flow depends on the current directory; non-interactive defaults to docs"
`--name <slug>`	string	Project slug written to docs.json. If omitted, interactive mode prompts and non-interactive mode derives it from the chosen location.	Yes	—
`--template <name>`	string	Scaffold an alternate template. Use "starter" for repo hygiene, helper files, and branding assets.	Yes	"minimal"
`--yes`	boolean	Accept defaults without prompting.

Examples

blodemd new

blodemd new stops with an error if the target directory already contains any scaffolded files. It also refuses to scaffold into a non-empty directory unless you confirm that interactively.

Next steps

Review docs.json and change name if you want a different project slug. This determines the default {name}.blode.md subdomain.
If you used the starter template, replace the generated helper files and brand assets with project-specific content.
Add more .mdx pages and update the navigation array.
Run blodemd push to deploy.