Ship your AIUI docs site to GitHub Pages with one workflow file.
Create aiui.template.yaml:
aiui.template.yaml
Create .github/workflows/deploy.yml:
.github/workflows/deploy.yml
1. Go to Settings → Pages in your GitHub repo
2. Set Source to Deploy from a branch
Deploy from a branch
3. Set Branch to gh-pages / / (root)
gh-pages
/ (root)
4. Push to main — your site deploys automatically
main
To use a custom domain (e.g., docs.example.com):
docs.example.com
1. Create a CNAME file in your repo root:
CNAME
2. Configure DNS — add a CNAME record pointing to <username>.github.io
<username>.github.io
3. The workflow above automatically copies CNAME into the build output
Already using MkDocs? The migration is simple:
| MkDocs | AIUI |
|--------|------|
| mkdocs.yml | aiui.template.yaml |
mkdocs.yml
| mkdocs build → ./site/ | aiui build --output site → ./site/ |
mkdocs build
./site/
aiui build --output site
| mkdocs serve | aiui serve |
mkdocs serve
aiui serve
| pip install mkdocs-material | pip install aiui |
pip install mkdocs-material
pip install aiui
Your existing docs/ folder works as-is — just swap the config and build command.
docs/
1. Create aiui.template.yaml (see example above)
2. Replace mkdocs build with aiui build --output site --minify in your CI workflow
aiui build --output site --minify
3. Remove mkdocs.yml (optional — keep for reference)
4. Push to main
Preview your site before deploying:
aiui build --output site produces:
Everything is static — no server required. GitHub Pages serves it directly.