Contributing
The only place you can contribute to this wiki is through the Github, via a Pull Request (PR).
How to modify the wiki
- Download Visual Studio Code and Github Desktop app.
- Create a Fork of this repository.
- Open the folder with Visual Studio Code.
- See the file that you need to modify by opening
mkdocs.yml
, for example the Getting Started page would bedocs/server/getting-started.md
. - 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
ormkdocs serve
- Go to http://localhost:8000/