

Contributing

Installation

To build and preview this site, you must have the following packages installed:

• mkdocs/mkdocs: the site generator
• squidfunk/mkdocs-material: the Material theme for MkDocs
• facelessuser/pymdown-extensions: a Python Markdown extension bundle

If you don't want to install the packages locally, use the official Docker image, which includes everything you need to preview, build, and deploy the documentation site.

docker pull squidfunk/mkdocs-material

For more installation options, see http://squidfunk.github.io/mkdocs-material/

Previewing docs

1. Fork and clone this repository.

2. Start the live development server from the project root.

   make serve
   

3. Add new files and save your changes.

4. Navigate to http://localhost:8000/ to review your updates.

Publishing docs

1. Push your changes to the upstream master branch.

2. Build the static site files.

   make build
   

3. Deploy the documentation site to GitHub Pages.

   make publish