documentation/README.md

37 lines
833 B
Markdown
Raw Permalink Normal View History

2022-01-30 17:13:12 +00:00
# Freifunk Leipzig Dokumentation
## Prozess für Änderungen
TBD.
MR, 4-Augen-Prinzip ...
## Build
Die Seite wird mit [Hugo](https://gohugo.io) erzeugt.
Zuerst muss das Repository mittels `git` und alles Submodulen ausgecheckt werden:
```sh
git clone --recursive https://git.dezentrale.cloud/Freifunk-Leipzig/documentation
```
Zum erstellen der Seite muss dann nur `hugo` aufgerufen werden:
```sh
hugo
```
Die fertige Website-Dateien werden dann im Verzeichnis `public` erstellt bzw. aktualisiert und können dann ggf. auf einen Webserver kopiert werden.
Für eine lokale Ansicht mit der Übernahme von Änderungen in Echtzeit bspw. für die Bearbeitung, kann folgender Befehl ausgeführt werden
```
hugo server
```
Die Website ist dann auf dem Rechner unter [http://localhost:1313](http://localhost:1313) abrufbar.