Contribute
If you want to help to make this wiki great you have got different options.
Either you install all dependencies or you open an issue.
- Clone this repository
- Install Dependencies
- Install Material for MkDocs with
pip install mkdocs-material
see also here - Install git-revision-date plugin with
pip3 install mkdocs-git-revision-date-plugin
- Install macros-plugin with
pip install mkdocs-macros-plugin
- Install Material for MkDocs with
-
Test your changes with local build
- move into folder wiki and start with command
mkdocs serve
-
Start your browser and go to the displayed IP (e.g. htps://localhost:8000)
Note
You can now change your files and save them,
mkdocs will recognize this and rebuild the site locally.
- move into folder wiki and start with command
-
Pull-Request your changes
- Click on the pencil icon on the site you want to edit
- Sign in to github with your github account
- Edit the site and do a pull-request
- Click on the issue icon on the site you want to open an issue for
- Sign in to github with your github account
- Insert a title for your issue and describe it in the comment section
Last update: 2021-09-27