AYAB Manual

This manual is mkdocs based.

Install mkdocs

python -m pip install mkdocs

View documentation locally

mkdocs serve

This command starts a local webserver at localhost:8000.

Build static documentation files (HTML)

mkdocs build

This command builds the documentation in ./site/

Deploy to Github Pages

mkdocs gh-deploy

Will build the static files and push to the gh-pages branch on Github, so they will be served automatically at manual.ayab-knitting.com