Skip to content

Contribute to this documentation

This documentation is build by using mkdocs.org. Visit the official site for their documentation. On top of that, a material theme is used.

How to get started

1) Clone Repository

First fork the repository for the documentation and then download the forked repository.

# Using ssh
git clone git@github.com:<GITHUB USERNAME>/azolyzer-docs.git

# Using https
git clone https://github.com/<GITHUB USERNAME>/azolyzer-docs.git

2) Install mkdocs and the material theme.

As mentioned above, visit the official documentation for more detail. You need to make sure, Python 3.x and pip is installed on your computer. Not every Python version is supported today. Now you can install mkdocs and the material theme. 

pip install mkdocs

pip install mkdocs-material

For more information about the used material theme, visit the documentation.

3) After changes are made, you can commit and push your changes back to github and then create a pull request to the official repository on the develop branch.

Commands

  • mkdocs serve - Start the live-reloading docs server.
  • 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.