Voraussetzungen
Um die Webseite bearbeiten zu können, braucht ihr Zugangsrechte für das FSMI Git Repository. Zudem sind Kenntnisse in Markdown und Git hilfreich.
Anlegen einer neuen Seite
Zunächst müsst ihr wissen, welche Seite ihr verändern oder wo ihr Seiten erstellen wollt.
Wir möchten zB eine neue Seite https://fsmi.upb.de/mitwirken/gremien erstellen. Dazu müssen wir in dem Git Repository
- falls noch nicht vorhanden einen Ordner Namens “mitwirken” erstellen
- in dem Ordner “mitwirken” einen Ordner “gremien”
- in diesem Ordner eine Datei Namens “index.md”
Bearbeiten einer vorhandenen Seite
Ist die Seite bereits erstellt worden und ihr wollt Inhalte nur verändern, dann gibts einen relativ einfachen Weg:
- geht auf die Webseite, die ihr verändern wollt.
- scrollt bis nach unten und klickt im Footer auf “Bearbeiten”.
- nun werdet ihr zur entsprechenden Seite im Git geleitet und könnt dort direkt Änderungen vornehmen und abspeichern.
- Änderungen werden nach dem Commit direkt übernommen.
Struktur der Datei
Der Inhalt wird, wie der Dateiname schon verrät, in Kramdown (Markdown) geschrieben. Die Dateistrukur sieht dabei wie folgt aus:
---
parameter: wert
---
Markdown Inhalte
Die zwei gestrichelten Linien sind dabei essentiell und müssen in jeder Datei drin sein! - zwischen ihnen können Parameter angegeben werden.
Unter den beiden Linien werden Seiteninhalte bevorzugt in Markdown und liquid, aber auch in HTML geschrieben.
Inhalte
Inhalte werden in Kramdown geschrieben. Die Grundlagen dazu findet ihr hier.
Parameter
Parameter definieren das Aussehen der Seite sowie Übersichten und Navigationen. Mehr dazu hier.
Beispiele
Findet ihr im Git-Repo zu jeder Seite. Durch die Ordnerstruktur solltet ihr bestimmte Seiten einfach finden können.