Skip to content
Snippets Groups Projects
Verified Commit f903bd57 authored by Jake's avatar Jake
Browse files

updated documentation

parent efdd2051
No related branches found
No related tags found
No related merge requests found
Pipeline #317897 passed
---
title: "Konfiguration"
tags: content
---
:::warning
TODO
:::
## Menüleiste & Startseite anpassen
Die Menüleiste und die Startseite werden über die [config.json](config.json) Datei konfiguriert.
Die Menüleiste kann (derzeitig nur) auf Kategorien und Artikel/Seiten verlinken. Um auf eine Seite in der Menüleiste zu verlinken, muss diese im Markdown Header, muss diese im Markdown Header den `slug` Wert gesetzt haben.
--- ---
title: "Kategorien & Ordnerstruktur" title: "Dateien, Kategorien & Ordnerstruktur"
--- ---
:::warning :::info
TODO Im [Inhaltsrepo](https://gitlab.gwdg.de/GAUMI-fginfo/fg-website-data) liegen die Inhalte für die Fachgruppenwebseite.
Auf dieser Seite findest du alle Informationen über die Struktur vom Inhaltsrepo.
::: :::
Für die Konfiguration gibt es die [config.json Datei](https://gitlab.gwdg.de/GAUMI-fginfo/fg-website-data/-/blob/main/config.json), worüber z.B. das Seitenmenü konfiguriert werden kann. Für weitere Informationen zur Konfiguration und was alles in diese Datei kann, siehe [hier](slug:config).
Ordner und Dateien die mit `.` anfangen werden beim Generieren der Webseite ignoriert.
:::danger
Alle Dateinamen im Inhaltsrepo müssen eindeutig sein!
Heißt es darf nicht zwei Dateien mit gleichem Namen in unterschiedlichen Ordnern geben.
Falls Dateien mit gleichem Namen existieren, kann die Webseite nicht gebaut werden.
(Außerdem darf es auch keine Dateien mit dem gleichen Namen einer Datei aus dem [statischen Teil des Themes](https://gitlab.gwdg.de/GAUMI-fginfo/fg-website/-/tree/master/theme/static) geben.)
:::
## Inhaltsdateien
Inhaltsdateien sind die Dateien aus denen die einzelnen Seiten mit Inhalt generiert werden.
Diese Dateien sind häufig [Markdown](slug:mdsyntax)dateien und folgen häufig dem Namensschema `<slug>.<lang>.md` (z.B. `imprint.de.md`).
Sie können entweder im Stammverzeichnis vom Inhaltsrepo liegen, oder in einem Unterordner(einer [Kategorie](#Kategorien)).
Weitere Informationen zum Erstellen und Schreiben von Inhaltsdateien findest du [hier](slug:createpage).
## Kategorien
Alle sonstigen Ordner repräsentiern eine Kategorie. Kategorien werden in der [config.json](config.json) Datei konfiguriert.
Dateien die in gar keinem Ordner abgelegt werden (also z.B. diese [README.md](README.md)), werden implizit in die `misc` Kategorie getan.
...@@ -3,5 +3,9 @@ title: "Markdown Syntax" ...@@ -3,5 +3,9 @@ title: "Markdown Syntax"
--- ---
:::warning :::warning
TODO TODO Markdown Syntax konkret dokumentieren!
::: :::
Die Markdown Syntax baut auf der Markdown Syntax von Pandoc auf. Es sind einige Extensions aktiviert, um die Syntax möglichst ähnlich zur Hedgedoc Markdown Syntax zu machen.
Einen Überblick über die Hedgedoc Markdown Syntax gibt es [hier](https://pad.gwdg.de/features)
...@@ -2,8 +2,20 @@ ...@@ -2,8 +2,20 @@
title: "Yaml Metadatenblock" title: "Yaml Metadatenblock"
--- ---
:::warning Eine jede Markdown Datei **muss** mit einem Metadaten Header anfangen.
TODO Dieser muss mindestens `title` gesetzt haben.
:::
Ein Metadaten Header sieht z.B. wie folgt aus:
```markdown
---
title: Mein toller Artikel
slug: mein_toller_artikel
status: published
tags: droggelbecher,foo,bar,hallo,welt
lang: de
---
```
Weiter Informationen zu möglichen Metadaten gibt es in der [Pelican Dokumentation](https://gaumi-fginfo.pages.gwdg.de/pelican/_build/html/content.html#file-metadata).
...@@ -8,3 +8,5 @@ TODO ...@@ -8,3 +8,5 @@ TODO
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment