README.md

Developer setup

Follow https://www.mkdocs.org/getting-started/ & https://squidfunk.github.io/mkdocs-material/getting-started/

Run :

• Via Python
  • pip install mkdocs mkdocs-material mkdocs-git-revision-date-localized-plugin mkdocs-redirects
  • mkdocs serve in the project root folder
  • Visit http://localhost:8000/
• Via Docker (in case you are not a big python fan)
  • build an image from de provided Dockerfile docker build -t chutney/doc .
  • in the project root folder run docker run --rm -p 8000:8000 -v ${PWD}:/docs chutney/doc
  • Visit http://localhost:8000/