Style Guide – MyST-Markdown#
Dieser Style-Guide definiert verbindliche Formatierungs- und Strukturregeln für die Erstellung von Inhalten im Projekt. Ziel ist eine konsistente, lehrbuchartige und technisch saubere Darstellung.
Allgemeine Prinzipien#
Ausgabe erfolgt immer als Markdown-Code.
Stil: präzise, knapp, fachsprachlich korrekt.
Jeder Satz beginnt in einer neuen Zeile.
Begriffe aus der Überschrift werden im Fließtext nicht erneut hervorgehoben.
Hervorhebungen:
kursiv: Fachbegriffe, zentrale Konzepte
fett: nur selektiv für starke Betonung
Überschriftenstruktur#
Eine Überschrift besteht immer aus drei zusammengehörigen Elementen:
Indexeinträge
Label
Überschrift
Diese bilden eine untrennbare Einheit.
Reihenfolge#
:::{index} single: Begriff
:::
(label)=
### Überschrift
Abstand#
5 Leerzeilen vor jeder Überschriftseinheit (Index + Label + Überschrift)
Indexierung#
Syntax:
:::{index} single: Begriff :::Mehrere Einträge erlaubt
Auch Unterkapitel erhalten eigene Indexeinträge
Semantische Verknüpfungen möglich:
:::{index} single: Oberbegriff; Unterbegriff :::
Labels#
Syntax:
(label)=
Steht zwischen Index und Überschrift
Wird für Referenzen (
{ref}) verwendet
Field Lists#
Grundsyntax#
Begriff
: Definition
Regeln#
Keine Leerzeile zwischen Begriff und Definition
Einrückung: genau 4 Spaces
Kein Tab-Mix
Mehrzeilig#
Begriff
: Erste Zeile
Zweite Zeile
Abstand#
2 Leerzeilen vor und nach jedem Field-List-Block
Typografie#
Abkürzungen: Begriff (Abk1, Abk2)
Einheiten konsistent (µl, cm², g/dl)
Zahlenbereiche mit Gedankenstrich (–)
„z. B.“ korrekt schreiben
Hervorhebungen#
kursiv: Fachbegriffe
fett: selten, nur bei Bedarf
Keine Wiederholung von Überschriftenbegriffen
Fließtext#
Jeder Satz in neuer Zeile
Prägnant, ohne Füllwörter
Klinische Relevanz priorisieren
Ziel#
Konsistenz
Lesbarkeit
MyST-/Sphinx-Kompatibilität