Contributing

The source of this documentation is available on Github. The documentation is written in markdown files which are located in the ./docs folder. Upon publishing they will be rendered to a website using MkDocs.

For full documentation visit mkdocs.org. When writing documentation locally it is highly recommended to use the tool to verify its output before committing.

Commands

• mkdocs new [dir-name] - Create a new project.
• mkdocs serve - Start the live-reloading docs server.
• mkdocs build - Build the documentation site.
• mkdocs -h - Print help message and exit.

Project layout

mkdocs.yml    # The configuration file.
docs/
    index.md  # The documentation homepage.
    ...       # Other markdown pages, images and other files.