GitHub Pages¶

The documentation site is built with MkDocs Material and deployed by GitHub Actions.

Domain¶

Primary domain:

nuzo.com.br

The custom domain is declared in:

docs/CNAME

MkDocs copies that file into the built site/ directory during deployment.

Local Preview¶

Install dependencies:

pip install -r requirements-docs.txt

Run the docs server:

mkdocs serve

Build strictly:

mkdocs build --strict

GitHub Repository Settings¶

After the repository is created on GitHub:

Open repository settings.
Go to Pages.
Set source to GitHub Actions.
Confirm the custom domain is nuzo.com.br.
Enable Enforce HTTPS after DNS is valid.

DNS¶

For an apex domain, configure GitHub Pages DNS records.

Recommended records:

A     @     185.199.108.153
A     @     185.199.109.153
A     @     185.199.110.153
A     @     185.199.111.153
AAAA  @     2606:50c0:8000::153
AAAA  @     2606:50c0:8001::153
AAAA  @     2606:50c0:8002::153
AAAA  @     2606:50c0:8003::153

Optional www redirect:

CNAME www nuzo.com.br

Deployment¶

The workflow is:

.github/workflows/pages.yml

It runs on pushes to main and manual dispatch.