Browse Source

wip documentation started

master
adminuser 6 years ago
parent
commit
611cdec8bd
  1. 45
      README.md

45
README.md

@ -1,13 +1,46 @@
# kollegen-hugo
Die Kolleenrunden-Website besteht aus statischen Webseiten, die mittels dem Hugo-Framwork generiert werden. Es gibt zwei Repositories: kollegen-posts für die Inhalte der Blog-Beiträge und kollegen-hugo, was die Generierungsgrundlage beinhaltet. Um redaktionell mitzubloggen, benötigt man nur das Posts- Repository. Die Anleitung dazu findet man [dort](https://kollegen.uber.space/gitea/kollegenredaktion/kollegen-posts).
Die Kolleenrunden-Website besteht aus statischen Webseiten, die mittels dem Hugo-Framwork generiert werden. Es gibt zwei Repositories: kollegen-posts für die Inhalte der Blog-Beiträge und kollegen-hugo, was die Generierungsgrundlage beinhaltet. Um redaktionell mitzubloggen, benötigt man nur das Posts- Repository. Die Anleitung dazu findet man [dort](https://kollegen.uber.space/gitea/kollegenrunde/kollegen-posts.git).
Diese Repository wird für Website-Verbesserungen benötigt, was im Folgenden beschrieben ist.
Diese Repository wird für Website-Bearbeitung benötigt, was im Folgenden beschrieben ist.
## Lokales Setup
Vorraussetzungen:
- Installierten git-Client
- Python3-Interpreter
- Gitea-User in der kollegenredaktion mit Editor-Berechtigung.
Klappt auf Linux, Windows und Mac. Beschrieben ist es her für Linux.
Voraussetzungen:
- Installierter git-Client: [https://git-scm.com/downloads]
- Gitea-User aus dem [Owners](https://kollegen.uber.space/gitea/org/kollegenrunde/teams/owners)-Team
### Verzeichnis anlegen
Die Installation kann in einem beliebigen Verzeichnis erfolgen, wir nehmen ~/kred und installieren dort das aktuelle Hugo-Release und das kollegen-hugo/Repository, jeweils in ein Unterverzeichnis:
>$ mkdir ~/kred
>$ cd ~/kred
>$ mkdir hugo
### Hugo-Release installieren
Das aktuelles hugo-Release für seine Zielplattform findet man auf gitHub: [https://github.com/gohugoio/hugo/releases/latest].
Wenn das aktuelle Hugo-Relase 0.76.4 ist, gilt für Linux:
>$ wget https://github.com/gohugoio/hugo/releases/download/v0.76.4/hugo_0.76.4_Linux-64bit.tar.gz
> ...
> hugo_0.76.4_Linux-64bit.tar. 100%[============================================>] 13,31M 1,54MB/s in 25s
> 2020-10-13 21:09:43 (547 KB/s) - »hugo_0.76.4_Linux-64bit.tar.gz« gespeichert [13953675/13953675]
>
>$ tar -xvf hugo_0.76.4_Linux-64bit.tar.gz --directory hugo
>$ rm hugo_0.76.4_Linux-64bit.tar.gz
Nach erfolgreicher Installation sollte Hugo seine Version ausgeben können:
>$ hugo/hugo version
> Hugo Static Site Generator v0.76.4-50DFE40B linux/amd64 BuildDate: 2020-10-12T08:36:20Z
### Repository holen
Das Repository wird geklont und installiert sich um Unterverzeichnis:
> git clone https://kollegen.uber.space/gitea/kollegenrunde/kollegen-hugo.git
>
Loading…
Cancel
Save