This site uses mkdocs. Python >=3.5 is required.

1. Clone this repository.
2. (optional) Setup a Python virtual environment.
3. Install the required packages with pip: pip3 install -r requirements.txt
4. Change the working directory to ./ChunkyDocs
5. Serve the site for development: python3 -m mkdocs serve
6. Build a preview of the final site: python3 -m mkdocs build

If you don't have Python installed, you can also use Docker.

• Serve the site for development: docker run --rm -it -p 8000:8000 -v ${PWD}/ChunkyDocs:/docs squidfunk/mkdocs-material
• Build a preview of the final site: docker run --rm -it -v ${PWD}/ChunkyDocs:/docs squidfunk/mkdocs-material build

Except where otherwise noted, the content of the Chunky Manual is available under a Create Commons Attribution-NonCommercial-ShareAlike 4.0 International license.