Installation

Install Static Docs from PyPI:

pip install static-docs

For local development inside this repository:

pip install -e .

Quick start

Scaffold a project, preview it with live reload, then build production output:

# 1. Scaffold a new project
static-docs init my-docs

# 2. Preview with live reload
static-docs preview --config my-docs/site.toml

# 3. Build for production
static-docs build --config my-docs/site.toml

You can pass either the config file or the project directory:

static-docs preview --config my-docs

When --config points at a directory, Static Docs reads site.toml inside that directory.

Scaffolded files

static-docs init my-docs

You get:

Build output

static-docs build --config my-docs/site.toml

You get: