From a5842ddd140d2ea80b2a26ea840eac43f550d4de Mon Sep 17 00:00:00 2001 From: Patrick Neff Date: Sat, 5 Jan 2019 03:05:32 +0100 Subject: [PATCH] Update README --- README.md | 35 ++++++++++++++++++++++++++++++++++- 1 file changed, 34 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ad072f9..7ae5bc8 100644 --- a/README.md +++ b/README.md @@ -26,4 +26,37 @@ auf einer lokalen Festplatte liegen hat. cd QUELLVERZEICHNIS hugo -Nachem die Webseite erstellt wurde liegen im Verzeichnis `QUELLVERZEICHNIS\public` die erstellten Daten, die auf den jeweiligen Webhoster hochgeladen werden. \ No newline at end of file +Nachem die Webseite erstellt wurde liegen im Verzeichnis `QUELLVERZEICHNIS\public` die erstellten Daten, die auf den jeweiligen Webhoster hochgeladen werden. + +## Neuen Artikel / Neue Seite erstellen + +Für `TYP` können folgende sachen eingesetzt werden: `bauen-und-wohnen`, `grabmale` und `neuigkeiten` + +`NAME` ist der Titel des Artikels in Kleinbuchstaben mit Bindestrichen anstatt Leerzeichen + + cd QUELLVERZEICHNIS + hugo new TYP/NAME/index.md + +Wenn die neue Seite angelegt wurde liegt diese im Ordner +`QUELLVERZEICHNIS\content\TYP\NAME` als `index.md` für Bilder muss in disem +Ordner ein neuer Ordner `bilder` (klein geschrieben) erstellt werden und dort +können Bilder im `jpg` Format abgelegt werden. Die Dateiendung sollte +ebenfalls wie der Dateiname komplett in Kleinbuchstaben sein und keine +Leerzeichen enthalten. + +## Seiten editieren + +Für `TYP` können folgende sachen eingesetzt werden: `bauen-und-wohnen`, `grabmale` und `neuigkeiten` + +`NAME` ist der Titel des Artikels in Kleinbuchstaben mit Bindestrichen anstatt Leerzeichen + +Die zu editierende Seite liegt unter +`QUELLVERZEICHNIS\content\TYP\NAME` als `index.md` diese ist mit einem Texteditor der Wahl zu öffnen. Es handelt sich um eine Datei im [Markdown](https://daringfireball.io/markdown) Format mit [TOML](toml-link) Kopfdaten. + +In den Kopfdaten sind sachen wie der Titel der Seite, Das veröffentlichungsdatum, der "draft" Status der besagt ob eine Datei veröffentlicht ist oder noch eine Vorschau, die nicht im normalen erstellen der Seite auftauche (dafür bracuht es beim erstellen das `-D` flag für hugo). + +Andererseits werden an dieser stelle auch die Metadaten für Bilder eingegeben. So wie das HTML alt Attribut, das als Bildbeschreibung dient wenn das Bild nicht angezeigt wird, einen Bild Titel und falls es sich um eine Neuigkeit handelt das "featured" Attribut, das besagt welches Bild für das Haupt Bild des News Artikels darstellt. + +### Bilder + +Bilder werden im \ No newline at end of file