„README.md“ ändern

3 years ago · 6ba1cc8386
1 changed files with 64 additions and 46 deletions
--- a/README.md
+++ b/README.md
@ -33,12 +33,13 @@ $ 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. Unter Linux geht das so:

->$ cd ~/kred/kollegen-posts/redaktion/  
->$ python3 -m venv .venv                    # Virtuelle Umgebung anlegen  
->$ source .venv/bin/activate                # aufrufen  
->(.venv) $ pip install -r requirements.txt  # Benötigte Paket installieren  
->$ deactivate                               # venv verlassen
-
+```console
+$ cd ~/kred/kollegen-posts/redaktion/  
+$ python3 -m venv .venv                    # Virtuelle Umgebung anlegen  
+$ source .venv/bin/activate                # aufrufen  
+(.venv) $ 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.
@ -47,10 +48,12 @@ Damit ist die Installation abgeschlossen. Es werden nun einzelne Schritte der re

 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  
+```console
+$ 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.

@ -59,32 +62,42 @@ Das Python-Skript vereinfacht Erstellung und Bearbeitung eines Posts. Im Verzeic

 Das Skript setzt das Unterverzeichnis in/posts voraus. Falls nicht vorhanden:

->$ mkdir -p ~/kred/kollegen-posts/redaktion/in/posts 
+```console
+$ mkdir -p ~/kred/kollegen-posts/redaktion/in/posts 
+```

 Anlegen neuen Posts (auch Bearbeiten eines existierenden Posts)  
->$ cd ~/kred/kollegen-posts/redaktion  
->$ .venv/bin/python red.py init 20160216  
->Existing in path found. Put your original images here: 'in/posts/20160216'  
->Post' directory created: '../content/posts/20160216'   
->New post file created: '../content/posts/20160216/index.md'  
->Image directory created: 'images'   
->The next step would be to add your images into the 'in/posts/20160216' directory. After that you can update the post directory '../content/posts/20160216' and the post file 'index.md': call 'update'.  

+```console
+$ cd ~/kred/kollegen-posts/redaktion  
+$ .venv/bin/python red.py init 20160216  
+Existing in path found. Put your original images here: 'in/posts/20160216'  
+Post' directory created: '../content/posts/20160216'   
+New post file created: '../content/posts/20160216/index.md'  
+Image directory created: 'images'   
+The next step would be to add your images into the 'in/posts/20160216' directory. After that you can update the post directory '../content/posts/20160216' and the post file 'index.md': call 'update'.  
+```

 Damit werden die Verzeichnis ~/kred/kollegen-posts/redaktion/in/posts/20160216 und ~/kred/kollegen-posts/content/posts/20160216 angelegt (falls nicht vorhanden) und die Datei index.md initialisiert. Der Post ist nun initialisiert.

 Nun können eigenen Bilder in Originalgröße abgelegt werden, z. B.:

->$ cp meine/bilder/*.jpg ~/kred/kollegen-posts/redaktion/in/posts/20160216/
+```console
+$ cp meine/bilder/*.jpg ~/kred/kollegen-posts/redaktion/in/posts/20160216/
+```

 Unter Linux kann man diese beiden Schritte auch mit den Skript load.sh ausführen:

->$ ./load.sh meine/bilder 
+```console
+$ ./load.sh meine/bilder 
+```

 Mit 'update' werden nun die Bilder konvertiert und im Zielverzeichnis abgelegt und in der Post-Datei index.md werden die Bild-Variablen initialisiert.

->$ .venv/bin/python red.py update  
->Done.
+```console
+$ .venv/bin/python red.py update  
+Done.
+``` 

 Nun kann der Blogbeitrag in der Datei ~/kred/kollegen-posts/content/posts/20160216/index.md editiert werden. 

@ -94,11 +107,13 @@ Die so erzeugte bzw. geänderte Datei besteht aus zwei Bereichen. Zuerst kommen

 Der lokale Server erkennt Änderungen und aktualisiert die Webseite automtatisch. Bei Problemen kann man die Generierung auch manuelle anstarten:

->$ cd ~/kred/kollegen-posts  
->$ ../hugo/hugo  
->Start building sites …   
->...  
->Total in 793 ms  
+```console
+$ cd ~/kred/kollegen-posts  
+$ ../hugo/hugo  
+Start building sites …   
+...  
+Total in 793 ms  
+```

 Oder auch den Server neu starten.

@ -106,32 +121,35 @@ Oder auch den Server neu starten.

 Ist die Post-Bearbeitung fertig, kann man das Eingangsverzeichnis entfernt werden (optional).

->$ .venv/bin/python red.py  cleanup  
->Removed 'in/posts/20160216'  
->20160216 closed.  
-
+```console
+$ .venv/bin/python red.py  cleanup  
+Removed 'in/posts/20160216'  
+20160216 closed.  
+```

 ### Neuen Post veröffentlichen

 Jetzt werden die Änderungen im content-Verzeichnis eingecheckt und hochgeladen. Mit dem Push werden die Generierung auf dem Server angestartet.

->$ pwd
->$ ~/kred/kollegen-posts
->$ git status  
->...  
->Unversionierte Dateien:  
->  (benutzen Sie "git add <Datei>...", um die Änderungen zum Commit vorzumerken)  
->        ../content/posts/20160216/  
->...  
->$ git add ../content/posts/20160216/  # Alternative: git add ../.  
->$ git commit -m 'Neuer Post 20160417'  
->...
->$ git push
->...
->remote: Total in 1698 ms  
->remote: Fertig, Blog wurde erzeugt!  
->To https://kollegen.uber.space/gitea/kollegenrunde/kollegen-posts.git  
->   0844f83..2546997  master -> master  
+```console
+$ pwd
+$ ~/kred/kollegen-posts
+$ git status  
+...  
+Unversionierte Dateien:  
+  (benutzen Sie "git add <Datei>...", um die Änderungen zum Commit vorzumerken)  
+        ../content/posts/20160216/  
+...  
+$ git add ../content/posts/20160216/  # Alternative: git add ../.  
+$ git commit -m 'Neuer Post 20160417'  
+...
+$ git push
+...
+remote: Total in 1698 ms  
+remote: Fertig, Blog wurde erzeugt!  
+To https://kollegen.uber.space/gitea/kollegenrunde/kollegen-posts.git  
+   0844f83..2546997  master -> master  
+```

 Glückwunsch!