Installation & Setup

Docboot does not require project scaffolding or manual installation. You can run it instantly using npx, pnpm dlx, or bun x.

1. Instant Execution (Recommended) #

Run Docboot on any folder of Markdown files:

npx docboot .

pnpm dlx docboot .

yarn dlx docboot .

bun x docboot .

2. Project Local Dependency #

If you want to add Docboot as a development dependency in your existing package.json:

npm install -D docboot

pnpm add -D docboot

yarn add -D docboot

bun add -D docboot

Add convenient scripts to your package.json:

package.json

JSON

{
  "scripts": {
    "docs:dev": "docboot ./docs -o",
    "docs:build": "docboot build ./docs",
    "docs:serve": "docboot serve ./dist",
    "docs:doctor": "docboot doctor ./docs"
  }
}

3. Global Installation #

To make docboot available everywhere as a global CLI tool:

BASH

npm install -g docboot

After installation, run docboot from any directory:

BASH

docboot .
docboot doctor
docboot build

Next Steps #

Configuration Reference — Optional custom configuration
Rich Content Primitives — Callouts, tabs, and details
CLI Reference — Full list of CLI commands and flags