1.1 Ordnerstruktur
Die Verzechnisstruktur eines Kurse folgt einem festen Schema.
Beispiel 1.1.1
[Wurzel]
├── _static
├── de
│ ├── _pages
│ ├── _static
│ ├── 01-project
│ │ ├── 01-folders
│ │ ├── 02-files
│ │ └── …
│ ├── 02-elements
│ │ ├── 01-headers
│ │ ├── 02-lists
│ │ └── …
│ └── …
├── en
│ ├── _pages
│ ├── _static
│ ├── 01-project
│ │ ├── 01-folders
│ │ ├── 02-files
│ │ └── …
│ ├── 02-elements
│ │ ├── 01-headers
│ │ ├── 02-lists
│ │ └── …
│ └── …
└── …Im Wurzelverzeichnis des Kurses befindet sich exakt ein Sprachordner für jede unterstützte Sprache.
Info 1.1.2
Jeder Sprachordner muss die exakt gleiche Unterordnerstruktur an Abschnitten enthalten.
Die Struktur des Kurses selbst ist durch Ordner und Unterordner definiert. Dabei entspricht jeder Ordner einem Abschnitt. Der Name des jeweiligen Ordners entspricht der Abschnitts-ID. Die Reihenfolge der Abschnitte im Inhaltsverzeichnis ergibt sich aus der alphanumerischen Sortierung der Ordnernamen. Daher wird empfohlen den Ordnernamen eine Nummer voranzustellen.
Info 1.1.3
Ordnernamen dürfen nicht mit einem
_ beginnen oder Leerzeichen beinhalten.Zusätzlich kann sich im Wurzelverzeichnis, sowie in jedem Sprachordner, ein Ordner
_static befinden, in dem statische Dateien, also Bilder und Videos abgelegt werden.In jedem Sprachordner kann außerdem ein Verzeichnis
_pages existieren, in dem sich die Seiten für die jeweilige Sprache befinden.Dateien
Im Wurzelverzeichnis befindet sich eine Datei
manifest.yml. Sie enthält Metadaten zum Kurs.In jedem Abschnittsordner existiert eine
content.md. Sie beinhaltet den Inhalt eines Kapitels. Darüber hinaus können beliebige Seiten angelegt werden. Für jede Seite wird eine Markdown-Datei im
_pages-Ordner abgelegt. Der Name dieser Datei entspricht der Seiten-ID, wie im pages-Feld des Kurs-Manifests angegeben.