From 693022ac23499bee8e048ccd043641c5ab4606c8 Mon Sep 17 00:00:00 2001 From: Hazel Noack Date: Fri, 16 May 2025 17:48:39 +0200 Subject: [PATCH] info on articles --- src/articles/documentation/get_started/de.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/src/articles/documentation/get_started/de.md b/src/articles/documentation/get_started/de.md index 82e3f9d..74482ff 100644 --- a/src/articles/documentation/get_started/de.md +++ b/src/articles/documentation/get_started/de.md @@ -8,3 +8,19 @@ Hier wird gezeigt wie man seine eigene website erstellen kann. ## Dateistruktur Die Dateien die den Content definieren findet man in `src`. Dort gibt es 3 Unterordner. In `templates` wird der Style und die Funktionalität der Webseite definiert. Wenn du nicht programmieren kannst, lass den in Ruhe. In `static` befinden sich Statische Dateien wie das css oder Bilder. Dieser Ordner wird bei dem Build einfach kopiert. Bei `articles` wird es interesannt. Dort befinden sich wie der Name schon sagt die Artikle. + +Wenn irgendetwas unklar ist, dann kann der code dieser Dokumentation (ist in eurer Fork) auch hilfreich sein. + +## Artikel schreiben + +Der Text für die Artikel ist immer in einer Datei mit folgendem namen `.md`. In diesem Fall wäre dies `de.md`. Dann kann der Artikel ganz normal mit dem [Markdown Syntax](https://www.markdownguide.org/) geschrieben werden. + +Soll der Artikel untergeordnete Artikel haben, so kann man dafür einfach ein neuen Ordner in dem jeweiligen Artikel erstellen. Der Name ist dann auch der Name der z.B. in der Url zu sehen ist. + +Will man Metadaten für den Artikel definieren (z.B. Name, Erstellungsdatum, Autor:in), dann kann man dies in der `index.toml` machen. Wenn noch keine existiert kann sie einfach erstellt werden. Hier ist ein Beispiel einer solchen Datei. + +```toml +name="stsg" +datetime="2024-04-15 13:45:12.123456" +author="Hazel" +```