Skip to content

Quick Start

Try It in 60 Seconds

pip install docglow
git clone https://github.com/docglow/docglow.git
cd docglow
docglow generate --project-dir examples/jaffle-shop --output-dir ./demo-site
docglow serve --dir ./demo-site

This uses the bundled jaffle_shop example project with pre-built dbt artifacts.

With Your Own Project

# 1. Generate the site from your dbt project
docglow generate --project-dir /path/to/dbt/project

# 2. Serve locally
docglow serve

Docglow reads target/manifest.json and target/catalog.json from your dbt project. Make sure you've run dbt compile (or dbt run / dbt build) first.

Single-File Mode

Generate a completely self-contained HTML file — no server needed:

docglow generate --project-dir /path/to/dbt --static
# Open target/docglow/index.html directly in your browser

The entire site (data, styles, JavaScript) is embedded in one file. Perfect for sharing via email, Slack, or committing to a repository.

What's Next?