diff --git a/README.md b/README.md index a29a6ee..c083084 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,48 @@ # kollegenrunde-posts +Dieses Repository beinhaltet den Content der Website sowie zum Editieren benötigte Helferlein. Im folgenden wird beschrieben, wie man Posts bearbeitet. + +Wie man dagegen die Website entwickelt, wird im Repository (kollegen-hugo)[https://kollegen.uber.space/gitea/kollegenrunde/kollegen-hugo] beschrieben. + +Generell werden ein Post editiert, in man lokal Hugo lokal ausführt und die Änderung testet und die Änderung commitet. Mit dem Push ins Kollegen-Gitea wird die Website dann dort neu generiert. + +Für kleine und rein textuelle Änderungen können auch direkt im Gitea-Repository durchgeführt werden, ohne lokale Installation. + +### Lokales Setup + +Hier wird nun beschrieben, wie man sich Hugo lokal einrichtet und lokale Post-Bearbeitung testet. + +Vorraussetzungen: +- git-Client ist installiert +- Python3 ist installiert + +Das Setup ist das gleiche, wie bei der Web-Entwicklung. Es wird ein leeres Verzeichnis benötigt, in das die beiden Repositories und das Hugo-Release installiert werden. Hier nochmal in Kürze (am Beispiel Linux): + +>$ mkdir ~/kred +>$ cd ~/kred +>$ wget https://github.com/gohugoio/hugo/releases/download/v0.76.4/hugo_0.76.4_Linux-64bit.tar.gz +>$ git clone https://kollegen.uber.space/gitea/kollegenrunde/kollegen-hugo.git +>$ git clone https://kollegen.uber.space/gitea/kollegenrunde/kollegen-posts.git + +Für Python wird nun noch die virtual Environment in einem neuen Unterverzeichnis installiert: + +>$ python3 -m venv .venv # Virtuelle Umgebung anlegen +>$ source .venv/bin/activate # aufrufen +>$ pip install -r requirements.txt # Benötigte Paket installieren +>$ deactivate # venv verlassen + +Hinweis: Die venv wird nicht in git eingeheckt, deshalb muss sie mit jeder Neuinstallation eingerichtet werden. + +Damit ist die Installation abgeschlossen. Es werden nun einzelne Schritte der redaktionellen Arbeit erläutert. + +### Website lokal testen + +Hugo kommt mit einem eigenen Webserver, so dass man lokale seine Änderungen testen kann. Um ihn auszuführen, muss man im Verzeichnis kollegen-hugo sein. + +>$ cd ~/kred/kollegen-hugo +>$ ../hugo/hugo server -D +Running in Fast Render Mode. For full rebuilds on change: hugo server --disableFastRender +Web Server is available at http://localhost:1313/kollegenrunde/ (bind address 127.0.0.1) + +Hat man alles richtig gemacht, kann man die Website nun im Browser sehen. +