siteenthält die aktuelle Webseite, welche vom Webserver angezeigt werden soll- Das Homeverzeichnis des Projekts beinhaltet die Quellcodes der Webseiten.
binbeinhaltet das Binary des statischen Webseiten-Generatorsaswsg(Linux, Intel Version).- Andere Unterverzeichnisse bilden die Unterseiten der Webseite ab.
Sofern nur der Inhalt der bestehenden Seiten geändert werden soll,
muss nur die entsprechende Seiten-Datei .pg oder
das passende Include .in geändert werden.
Für Änderungen der Verzeichnisstruktur muss die header.in
Datei angepasst werden.
Eine Seite beginnt immer mit der Definition eines Namens:
@page:<name>
Der Name wird verwendet, um den passenden Menüeintrag hervorzuheben und erscheint im Titel. Danach muss der Kopf der Seite eingebunden werden:
+header.in
Achtung! Wenn du eine Unterseite (in archiv oder projekte)
bearbeitetest must du die + include-Dateien mit als
relativen pfad mit ../ angeben, also z. B.
+../header.in.
Das Gleiche gilt auch für article-end.in und footer.in!
Der Inhalt einer Seite besteht aus einem oder
mehreren $<article> ... $</article> Gruppen.
Vor dem abschließenden $</article> muss eine Leerzeile sein,
um den vorherigen Paragraph zu beenden.
Der abschließende Paragraph kann auch durch das Include +article-end.in
ersetzt werden. Damit kann das am Ende eines Artikels durch Variablen
das Änderungsdatum (last_change), der/die Autor[in|en] (author)
und eine Lizenz (license) genannt werden.
Das Include löscht am Ende die Variablen, um eine automatische
Vererbung auf Folgeartikel zu verhindern.
Innerhalb eines Artikels wird mit Überschriftebene 3 begonnen.
Beispiel eines Artikel-Aufbaus:
$<article>
=== Überschrift Ebene 3
Lorem Ipsum dolor.
==== Überschrift Ebene 4
Sed diam nonumy eirmod tempor invidunt
ut labore et dolore magna
aliquyam erat, sed diam voluptua.
=== Überschrift für Eine Liste
* Aus mehreren Punkten
* Mit etwas Inhalt
* Ohne Sinn
@last_change:2021-09-08
@author:Marlene Muster
@license:CC BY 4.0
+article-end.in
Ein Artikel kann auch gut in ein Include geschrieben werden.
Am Ende der Seite wird der Fuß eingebunden.
footer.in
Links können schnell im Gemini Format => URL [TEXT] geschrieben werden.
Diese werden als
=> https://media.ccc.de/ CCC Video Archiv von Vorträgen
Interne Links sollten in der Form [[text|URL]] angegeben werden.
Zum Beispiel so:
[[Mailing-Liste|kontakt.html#Mailingliste]]
Externe Links sollten in der Form [text](URL) definiert werden, dann wird das Attribut rel=external hinzugefügt.
Zum Beispiel so:
[Wikipedia](https://www.wikipedia.de/)
Einfach das Shellscript make.sh im Projektverzeichnis ausführen.
Dieses aktualisiert das site Verzeichnis.
Bitte beachte, dass das Script das aswsg aus dem Verzeichnis
bin nimmt. Dieses ist für Linux ARM64
kompiliert.
Solltest du auf einer anderen Plattform arbeiten schaue hier
nach deiner passenden Version.
Wegen der Unterverzeichnisse und relativen Pfade musst du einen lokalen
Webserver aus dem site Verzeichnis des Repos starten.
Das ist total einfach, z.B. mit:
- Installiere das Caddy Binary aus deiner Paketverwaltung, oder schaue hier.
- Im Terminal wechsel in das das site Verzeichnis
.../DLUG-website/site. - Starte caddy mit
caddy file-server --listen :8910 - Öffne die lokale DLUG-Webseite mit http://localhost:8910.
(Du kannst den Port 8910 natürlich durch einen Anderen ersetzen.)
Alternativ für Python als Webserver, ersetze Schritt 3 mit:
python[3] -m http.server 8910
oder
python[2] -m SimpleHTTPServer 8910
Alternativ für den node.js http-server als Webserver, ersetze Schritt 1 mit:
- Installiere http-server mit
npm install -g http-server
Und Schritt 3 mit:
- Starte den Server mit
http-server -p 8910
- siehe darkhttpd
Mit ngrok kannst du die Seite sogar aus dem Internet testen.
pagekite bietet, wie ngrok, eine öffentliche URL.
Natürlich geht auch der Apache httpd, nginx und andere. Das Setup ist evtl. aufwendiger.
Ein git push sollte reichen.
WIP! Der Server hat ein Hook, welcher die den Webserver mit
den Inhalten des site Verzeichnisses aktualisiert.