Skip to content

TEMPLATE_LIBRARY_NAME

TEMPLATE_DESCRIPTION

Welcome to your library's docs site

After customizer.sh rebrands this template, replace this placeholder with your library's overview — value proposition, hero diagram or screenshot, primary use case in 1-2 sentences.

Quick start

// Replace this snippet with your library's smallest meaningful API.
// Goal: ≤ 10 lines of copy-paste-runnable code demonstrating the single
// most important capability.

Where to go next

Authoring docs

The site is built with mkdocs-material. Authoring conventions live in:

pip install -r docs/requirements.txt
mkdocs serve   # → http://127.0.0.1:8000

Both index.md and Home.md exist on purpose

mkdocs uses index.md for the root URL; the GitHub Wiki uses Home.md for its landing page. Edit both with the same content in every commit.