Quick Start

Assumes you have installed the template and are running ./run_dev.sh.

1. Rename the site

Open docs/_site.json and edit the branding:

{
  "site_name": "My Project Docs",
  "tagline": "Short tagline",
  "footer": "My Project Docs",
  "logo_href": "index.html"
}

The site_name drives the header logo, the <title> suffix, and (unless you override footer) the footer text. After editing, re-bake the chrome so every page picks up the change:

python3 docs/_lib/_wrap_handwritten.py

2. Edit the landing page

The root URL / serves docs/index.html. Open it and replace the content inside <main class="doc-body">…</main> with your project's welcome text. Leave the <main> wrapper in place — the wrap script keys off it.

3. Add content

Add a page

Create an HTML file inside a tab directory with a <title> and a <main class="doc-body"> block:

cat > docs/pages/guide/architecture.html <<'EOF'
<!DOCTYPE html><html lang="en"><head><meta charset="UTF-8">
<title>Architecture</title></head><body>
<main class="doc-body">
<h1>Architecture</h1>
<h2 id="overview">Overview</h2>
<p>…</p>
</main></body></html>
EOF
python3 docs/_lib/_wrap_handwritten.py

Refresh the browser — the page appears in the Guide sidebar. Headings with an id attribute (<h2 id="overview">) automatically populate the on-this-page TOC on the right.

Control the order

By default sidebar pages sort alphabetically (with index.html first). To pin a custom order, list the file stems in the tab's docs/pages/guide/_tab.json:

"order": ["index", "installation", "architecture", "quick-start", "why", "conventions"]

Add a tab

Create a new directory under docs/pages/ with at least an index.html:

mkdir docs/pages/reference
# author docs/pages/reference/index.html with a <main class="doc-body"> block
python3 docs/_lib/_wrap_handwritten.py

A Reference tab appears. See Recipes → Add a tab for labels, ordering, and sidebar sections.

4. Ship

There's no build. Copy docs/ to any static host. See Installation → Deploy.

Why this pattern — understand the tradeoffs before deviating.
Conventions — the full ruleset.
Recipes — common tasks with worked examples.