Render commands

Rendered output is styled, self-contained HTML — inline CSS + SVG diagrams, no runtime JavaScript. Six themes; see Slides & theming.

avo preview

Render one doc to a temp HTML file and open it in your browser.

avo preview docs/orders.md

The live docs site: avo studio, Site mode

The local, live-reloading docs site lives inside avo studio — switch the top bar to Site and the whole built site (index, sidebar nav, cross-doc links, the Doc | Slides toggle on every page) renders in place, rebuilt + reloaded on save.

avo studio                   # --port, --no-open — then Edit | Site | Present

Editing with an AI agent while avo studio is open? The files are the source of truth, so outside changes repaint live — in Edit and Site mode alike.

Compat: avo serve still works and serves the same pages standalone (--port, --no-open), but it's hidden from help — studio's Site mode is the supported local surface.

avo html

Render one doc to a standalone HTML page.

avo html docs/orders.md -o orders.html
avo html docs/orders.md -p            # render to a temp file and open it

avo pdf

Render one doc to a PDF (headless Chromium under the hood).

avo pdf docs/plan.md         # → plan.pdf   (-p opens it)

Chromium is downloaded automatically on first use (~100 MB, one time); to pre-install: npx playwright install chromium.

avo build

Build a static HTML site from all docs — an index page, sidebar nav, cross-doc links, and the Doc | Slides toggle on every page.

avo build                    # → dist/    (--out <dir>)

The live demo on this site is exactly this: avo build run over this repo's own docs.

Conventions

The one-doc shortcuts (html/slides/pdf) take -o, --output <path> to write a specific file, or -p, --preview to render to a temp file and open it.