README.md

docs

📝 documentation repository for gaia

pre-requisites

We use mkdocs to build the documentation as a static website, from markdown files. The theme used is mkdocs-material.

See mkdocs-material documentation for installation instruction.

pip3 install mkdocs-material

serving the documentation locally

with mkdocs

mkdocs serve

with docker

docker run --rm -it -p 8000:8000 -v $(pwd):/docs squidfunk/mkdocs-material

publishing the docs locally

mkdocs gh-deploy --force