This site uses mkdocs. Python version 3.5 or greater is required.

1. Clone this repository.

2. (optional) Set up a Python virtual environment.

3. Install the required packages with pip by using the command, pip3 install -r requirements.txt.

4. If running Windows, simply run serve.bat. Otherwise, change the working directory to ./ChunkyDocs.

5. Serve the site for development by using the command, python -m mkdocs serve.

6. Build a preview of the final site by using the command, python -m mkdocs build.

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

• Serve the site for development by using the command, docker run --rm -it -p 8000:8000 -v ${PWD}/ChunkyDocs:/docs squidfunk/mkdocs-material.

• Build a preview of the final site by using the command, 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 Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International license.