Skip to content

Contributing

The only place you can contribute to this wiki is through the Github, via a Pull Request (PR).

How to modify the wiki

  1. Download Visual Studio Code and Github Desktop app.
  2. Create a Fork of this repository.
  3. Open the folder with Visual Studio Code.
  4. See the file that you need to modify by opening mkdocs.yml, for example the Getting Started page would be docs/server/getting-started.md.
  5. Modify page contents using Markdown or HTML

Modify the wiki on phone

The Github app actually lets you modify the page and create a pull request really easy!

Helpful tips

  • You can use any emoji from here like :material-cog: which is a
  • If you want to see how your edition would look, you can go to Markdown Editor but if you want to test if locally keep reading!

Test locally

  • Install Python
  • Open the project folder
  • Go to Terminal > New Terminal
  • Install holiwis' dependencies:
pip install mkdocs
pip install mkdocs-material
pip install mkdocs-glightbox
  • Run python -m mkdocs serve or mkdocs serve
  • Go to http://localhost:8000/