About this site¶
This is the central documentation hub for Aldo Fieuw's projects. It aggregates
documentation from several repositories at build time using
mkdocs-multirepo-plugin
— each section below is pulled live from its source repo when this site builds.
How the docs are organized¶
| Section | Source | Notes |
|---|---|---|
| Clock | Aldo-f/clock (main) |
Special clocks — features & development docs |
| Thuis main | Aldo-f/thuis (main) |
Current MkDocs-based documentation (EN + NL) |
| Thuis v5 | thuis branch v5/main |
Docusaurus-era docs: getting started, API, architecture |
| Thuis v4 | thuis tag v4.1.0 |
Docusaurus-era docs: installation, usage, credentials |
| Thuis v3 | thuis tag v3.0.0 |
Legacy single-file Python version (MkDocs, EN + NL) |
Adding a new repository¶
- Make sure the repo is public and keeps markdown under a top-level
docs/directory (or pointdocs_dirat another path inmkdocs.yml). - Add a
nav_reposentry tomkdocs.ymlwith the repo URL and branch. - Add a matching item under
nav:pointing at the importedindex.md. - Push to
main— GitHub Actions rebuilds and deploys automatically.
Deployment¶
The site deploys via .github/workflows/deploy.yml on every push to main.
Build locally with:
source venv/bin/activate
mkdocs build --strict