Stand: 17.01.2022
Diese Datei beschreibt, wie BITS über das Werkzeug "Hugo" bearbeitet werden kann.
Alternativ kann die HTML-Version von BITS heruntergeladen und direkt über einen Text-Editor in den statischen HTML-Seiten gearbeitet werden. Dies entspricht BITS, wie es bis Version 5.5 entwickelt wurde. Außerdem gibt es neben dieser HTML-Version ein weiteres Archiv mit dem gleichen Stand, das die Installation auf einem Web-Server ermöglicht - damit funktioniert die eingebaute Suche. In diesen Download-Archiven (Repositorys) ist im Unterordner /static eine weitere Readme.md enthalten, die konkrete Hinweise zur Anpassung, aber auch zur Aktivierung des Gewinnspiels etc. beinhaltet.
Das BITS-Repository mit den beiden Download-Archiven ("Releases") liegt auf GitHub: BITS-hugo
Hier wird erläutert, wie BITS mithilfe von Hugo, einem Open Source-Programm zu Erstellung statischer HTML-Seiten mittels der Markdown-Sprache, angepasst werden kann. Damit kann wie mit einem What-you-see-is-what-you-get-Editor gearbeitet werden, um BITS auf die lokalen Gegebenheiten anzupassen. Für die Bearbeitung der Inhaltsdaten, die im Unterordner /content liegen, sind dann nur ein beliebiger Text-Editor und ein Browser nötig. Dies Bearbeitung kann aber auch über die statischen HTML-Seiten aus dem Repository-Archiv und einen Text-Editor erfolgen.
Zunächst muss Hugo in der extended Version heruntergeladen werden. Hugo steht u.a. für Windows, Linux, MacOS, BSD zur Verfügung. Hier wird die Installation der Windows-Variante vorgestellt.
Download hugo from GitHub releases
Anschließend muss Hugo installiert werden, siehe die Installationsanweisungen.
Die EXE-Datei sollte, für einfache Verwendung, in einem Pfad gespeichert sein, der in der PATH-Variable des Betriebssystems enthalten ist. Alternativ kann sie auch in das Projektverzeichnis kopiert werden.
Nach der Installation von Hugo ist das BITS-hugo-Repository von GitHub herunter zu laden.
-
Lokales Klonen des Repositorys (rekursiv!)
git clone --recursive https://github.com/BITS-Editor/BITS-hugo
-
Lokal in das heruntergeladene Repository-Verzeichnis wechseln
cd BITS-hugo -
Hugo-Server starten
hugo server
-
Browser öffnen und auf http://localhost:1313 navigieren
Anpassungen an den Markdown-Dateien, insbesondere im Unterordner /content, können mit einem beliebigen Text-Editor vorgenommen werden.
- Änderungen werden direkt von Hugo erkannt und im Browser bei laufendem hugo server sofort nach dem Speichern angezeigt, mit Ausnahme von Variablen (vgl. nächster Punkt)
- Tipps und weitere Infos u.a. zu Variablen findet man in der Datei RelearnTheme-howto.md
Mit folgenden Befehlen werden anschließend im Unterverzeichnis "public" die HTML-Dateien von Hugo für die Veröffentlichung für die Beschäftigten auf einem Web- oder Fileserver generiert:
-
für die Verwendung mit einem Webserver und voller Funktionalität:
hugo --cleanDestinationDir
-
für die Verwendung ohne Webserver auf einem Fileserver als statische HTML-Dateien (Suche geht nicht!):
hugo --environment html --cleanDestinationDir
Hinweise zur Installation der Releases und den sinnvollen lokalen Anpassungen der Inhalte und des Layouts liegen hier: https://github.com/BITS-Training/BITS-hugo/blob/main/static/README.md
Hugo arbeitet mit sog. Themes, die für das Layout zuständig sind. BITS-hugo verwendet das Relearn-Theme: https://themes.gohugo.io/themes/hugo-theme-relearn/
Welche Anpassungen über Parameter und Variablen in BITS für das ReLearn-Theme hinterlegt sind, steht in dieser Datei: https://github.com/BITS-Training/BITS-hugo/blob/main/ReLearnTheme-HowTo.md
Weitere Hinweise und Hilfe zu Hugo findet sich hier: https://gohugo.io/documentation/