Files
STSG/src/articles/documentation/get_started/de.md
2025-05-16 17:48:39 +02:00

1.4 KiB

Get Started

Hier wird gezeigt wie man seine eigene website erstellen kann.

  1. Fork das Projekt und Klone es lokal
  2. {{installation.link}}

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 <language_code>.md. In diesem Fall wäre dies de.md. Dann kann der Artikel ganz normal mit dem Markdown Syntax 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.

name="stsg"
datetime="2024-04-15 13:45:12.123456"
author="Hazel"