bunteshaus.de/docs/artikelstruktur.md

77 lines
3.7 KiB
Markdown
Raw Normal View History

2022-04-04 18:04:16 +02:00
# Anleitung fuer Artikel
## Grundlegendes
Jeder Artikel ist ein Ordner der in den Ordnern `content/events` `content/news` oder `content/bunteshaus` liegen kann.
Dadrin muss sich mindestens eine `index.*.md` Datei befinden und ggf. noch Bilder, die den Artikel illustrieren.
Das Sternchen steht dabei fuer `de`, `ku` oder `en`. Dieses steht für die Übersetzung des Artikels.
Ein Beispiel sieht so aus:
```
2022-04-04 18:23:02 +02:00
--content/news/2323.12.29-Konzert
2022-04-04 18:04:16 +02:00
|_ index.de.md
|_ index.en.md
|_ 1.jpg
```
Ein [Echtweltbeispiel](https://schlomp.space/Bunteshaus/bunteshaus.de/src/branch/main/content/events/06.11.2021-konzert).
Eine Methode ist, einen Artikel auf Deutsch anzulegen (`index.de.md`), diese Datei zu `index.ku.md` kopieren und dann den [Inhalt](https://schlomp.space/Bunteshaus/bunteshaus.de#inhalt) anzupassen
## Metadaten
```
1 ---
2 title: "Testtitel"
3 date: 2021-10-23T18:15:19+02:00
4 featured: false
2022-04-04 18:23:02 +02:00
5 about: false
6 when: "Jeden Montag, 19Uhr"
7 categories: ["Pressemitteilung"]
8 events: ["Konzert"]
9 tags: ["Interpretin 1", "Interpretin 2", "Interpret 3"]
10 price: "3€"
11 registeremail: "mail@bunteshaus.de"
12 covid: "3G"
13 ---
14 Endlich wieder Konzerte und den Auftakt macht Testtitel!
2022-04-04 18:04:16 +02:00
```
2022-04-04 18:23:02 +02:00
Alles zwischen Zeile 1 und 13 sind die Metadaten. Zeile 1 und 13 Kennzeichnen die Metadaten.
2022-04-04 18:04:16 +02:00
Zeile 2 ist der Titel, wie er auf der Homepage auftauchen wird.
Zeile 3 ist das Datum und die Zeit (und Zeitzone (`+02:00`)), an dem der Artikel erstellt wird.
Zeile 4 kann benutzt werden, um den Artikel prominent zu Platzieren. (Pressemitteilungen etc.)
2022-04-04 18:23:02 +02:00
Zeile 5 damit wird ein artikel in die ueberuns kategorie aufgenommen (das projek "café" zb)
Zeile 6 wenn etwas ein Event ist, dann hat es ein Datum. Hier kann man das wie im beispiel angeben.
Zeile 7 da alles eine news ist, gibt man so die kategorie fuer diese an. Fuer zb Partys oder Konzerte Inhaus empfiehlt sich "Buha"
Zeile 8 Wenn etwas ein Event ist, kriegt es eine spezielle Kategorie. (Konzert, Party, Regelmäßig, Workshop (siehe Liste auf der homepage))
Zeile 9 zum taggen von artikeln. zb interpreten von konzerten, thematliche schwerpunkte, vortragende
Zeile 10 kann benutzt werden um die Kosten des Termin anzugeben. Füllbar mit Text "3€" oder "free"
Zeile 11 heisst irrtuemlich noch so, wird aber geaendert
Zeile 12 falls man noch vor covid warnen muss work in progress :D
2022-04-04 18:04:16 +02:00
**Die Zeilen 4-11 weglassen, wenn sie nicht benutzt werden.**
## Inhalt
Ab Zeile 13 ist der Inhalt des Artikels:
Soll eine Überschrift im Text passieren, schreibe `##` davor. Eine Unterüberschrift geht mit `###`
Soll etwas **fett** geschrieben werden, schreibe `**` davor und dahinter.
Soll eine neue Zeile angefangen werden, schreibe zwei Leerzeichen hinter den Satz.
Soll ein Absatz gemacht werden, lasse eine Zeile zwischen Absatz 1 und Absatz 2 frei.
Eine Link kann einfach geschrieben werden, allerdings kann man diesen auch gestalten:
`[Bunteshaus](https://bunteshaus.de)` wird [Bunteshaus](https://bunteshaus.de)
## Hilfsprogramm
Installiere dir `git` und `hugo` in deinem Linux und mach dir hier einen Account.
Danach "forkst" du dieses Projekt in deinen Account (oben rechts) und klonst das Projekt auf deinen Rechner.
Dann kannst du im Hauptordner des Projektes beispielsweise `hugo new events/80.12.2330-Konzert/index.de.md` ausführen und es wird der Ordner und die Standarddaten, wie oben beschrieben, in die Datei `index.de.md` geschrieben.
Dann kannst du die Datei in einem Standardprogramm verändern.
Wenn du damit zufrieden bist, machst du einen beschreibenden Commit und einen Pullrequest auf dieses Projekt und ein Admin wird benachrichtigt.
Wenn dein Artikel fertig ist, wird er in dieses Projekt gemerged und ist damit online!
Diese Anleitung ist nur ein grober Überblick.