This site uses mkdocs. Python >=3.5 is required.
- Clone this repository.
- (optional) Setup a Python virtual environment.
- Install the required packages with pip:
pip3 install -r requirements.txt
- Change the working directory to
./ChunkyDocs
- Serve the site for development:
python3 -m mkdocs serve
- 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.