Learn Void¶
A four-level path from first look to first contribution. Each level ends with a "verify you got it" checklist so you know you're ready to move on.
The levels¶
| Level | Name | Time | What you'll achieve |
|---|---|---|---|
| Level 1 | Explorer | ~30 min | Install, scaffold, tour the features |
| Level 2 | Maker | ~1–2 h | Write docs, use components, deploy to GitHub Pages |
| Level 3 | Customizer | ~half day | Override tokens, toggle components, add custom CSS/JS |
| Level 4 | Contributor | ongoing | Understand architecture, run tests, open a PR |
How to use this track¶
- Start at Level 1 if you're new to Void.
- If you already know the basics, skip to the level that matches your experience.
- Each level builds on the previous one — the checklists assume you've completed earlier levels.
- You don't have to complete the whole track in one sitting. Bookmark your level and come back.
Quick reference¶
- Install:
pip install mkdocs-void - Scaffold:
void new my-docs - Serve:
mkdocs serve - Build:
mkdocs build --strict - Test:
npm test - Docs lint:
python tools/check_docs.py