View the Docs by Clicking here!

Millennium Machines Documentation

This repository contains the source for the Millennium Machines documentation website.

While the documentation is written in Markdown, it is rendered using mkdocs and mkdocs-material, which allow for some custom formatting. You should view the documentation on the website itself, https://millenniummachines.github.io/docs rather than through the GitHub interface for the best experience.

Local preview and validation (Docker)

The repo includes a small image with the same MkDocs dependencies as GitHub Actions. From the repository root:

Script (same flows as below; run from repo root):

./scripts/docker-docs.sh build-image   # build the image once
./scripts/docker-docs.sh serve        # preview at http://localhost:8000
./scripts/docker-docs.sh validate     # mkdocs build → ./site
./scripts/docker-docs.sh validate --strict

Serve the docs (Material live reload works with the bind mount):

docker build -t millenniummachines-mkdocs .
docker run --rm -p 8000:8000 -v "$PWD:/workspace" -w /workspace millenniummachines-mkdocs

Open http://localhost:8000.

Validate a production-style build (writes site/ on the host):

docker run --rm -v "$PWD:/workspace" -w /workspace millenniummachines-mkdocs mkdocs build

Stricter check (fails on warnings):

docker run --rm -v "$PWD:/workspace" -w /workspace millenniummachines-mkdocs mkdocs build --strict

Compose (equivalent flows):

docker compose up serve
docker compose --profile validation run --rm build
docker compose --profile validation run --rm build mkdocs build --strict