Dokumentation

README.md

@@ -6,7 +6,7 @@ Hugo-basierter Blog mit dem Terminal-Theme. Der gesamte Content, liegt in disem
 
 Nur dieses git-Repository. Das Publishing erfolgt in das Website-Vezeichnis /home/kollegen/html. Dort muss die index.html liegen, da es die Startseite der Domain darstellt. Der zugreifende Gitea-User muss den ssh-Key konfigurierte haben, damit git und rsync per ssh genutzt werden kann.
 
-## Local Setup
+## Lokales Setup
 
 Benötigte Tools:
 
@@ -20,11 +20,21 @@ Das git-Repository auschecken. Es wird in ~/kollegen gearbeitet.
     $ mkdir ~/kollegen
     $ cd ~/kollegen
     $ git clone kollegen@kollegen.uber.space:website/blog.git
+    $ cd blog
+
+Das Theme **terminal** ist als submodule eingebunden, also nicht Teil des repos - das Verzeichnis themes/terminal ist dementsprechend leer. Laden von terminal:
+
+    $ git submodule init
+    Submodule 'themes/terminal' (https://github.com/panr/hugo-theme-terminal.git) registered for path 'themes/terminal'
+     $ git submodule update
+     Cloning into '/home/chris/prj/kollegen/blog/themes/terminal'...Submodule path 'themes/terminal': checked out '9d458d193fee9dd35843baddd41e1ba99c29aef4'
+
 
 Sollen auch Icons erstellt werden, wird noch das website-git benötigt:
 
     $ git clone kollegen@kollegen.uber.space:website/website.git
 
+
 ## Konfiguration des Blogs
 
 Es gibt posts und tiles. Tiles stellen die Link-Kacheln dar. 
@@ -35,4 +45,32 @@ Eine Bundle-Post:
 
     $ hugo new posts/RFduino-Implementation-of-DDO/index.md
 
+## Lokales Testen
+
+Starten der Vorschal im lokalen Webserver:
+
+    $  hugo server -D 
+    (...)
+    Web Server is available at http://localhost:1313/ (bind address 127.0.0.1)
+    Press Ctrl+C to stop
+
+## Update der Website
+
+Hugo generiert den Content nach /public. 
+
+    $ hugo
+    Start building sites … 
+    (...)
+    Total in 47 ms
+
+Das Skript startet hugo und kopiert anschließend /public in den Webcontent-Bereich auf Uberspace:
+
+    $ ./deploy
+
+
+Per Skript
 
+```mermaid
+graph TD
+Start --> End
+```