The documentation repository has two branches:
mkdocscontains the markdown documentation. You should work on this branch if you want to contribute and you should submit here your pull requests.
mastercontains the site compiled by Mkdocs. This branch is handled only by our Github Actions bot. No pull request will be merged on it.
Clone and Install
- Fork and clone the documentation repository
- Install MkDocs
- Install Cinder theme by running:
pip install mkdocs-cinder
- Install fontawesome-markdown extension by running:
pip install https://github.com/bmcorser/fontawesome-markdown/archive/master.zip
MkDocs uses Python-Markdown with some extensions active by default. It supports the standard markdown, markdown-extra and some of the Github-flavoured markdown features. You can find detailed information on https://www.mkdocs.org/user-guide/writing-your-docs/#writing-with-markdown.
admonition extension helps to write beautiful notes or warnings or other (see the official documentation) with a syntax like the following:
!!! Danger Very dangerous operation!
which translates into the following:
Very dangerous operation!
_I :fas fa-heart: phootwork!_
translates into: I phootwork!.