Add readme

This commit is contained in:
mcbloch 2021-10-10 22:45:57 +02:00
parent a93dc476d9
commit 19ef6e0774

17
README.md Normal file
View file

@ -0,0 +1,17 @@
# Zeus bestuur DRIVE
Maakt gebruikt van [MKDocs](https://www.mkdocs.org/) met het [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) thema om het visual aantrekkelijk te maken.
Je kunt deze vinden op [drive.zeus.gent](https://drive.zeus.gent).
## Aanpassingen maken
Je kunt via de website op het edit icoontje klikken. Hiermee ga je terecht komen in gitlab op de juiste pagina om de tekst aan te passen.
Voor grotere wijzigingen kan het nuttig zijn lokaal de wiki te builden om te verifieren dat het eruit ziet zoals gewenst.
1. Clone de wiki lokaal op je pc: `git clone ssh://git@git.zeus.gent:2222/bestuur/drive.git`
2. Voer MkDocs uit: `mkdocs serve`
Dit gaat de mkdocs server opstarten die automatisch gaat herladen bij het wijzigigen van bestanden in de drive.