Dateinamenskonventionen#

Übersicht der Dateiendungen, Namensregeln und automatischen Transformationen beim Build-Prozess.

Dateiendungen#

Web- und PDF-spezifische Dateien#

Die .web.*- und .pdf.*-Suffixe ermöglichen es, Inhalte für verschiedene Ausgabeformate zu trennen:

dokument/
├── einleitung.md           # Wird in beide Formate übernommen
├── anhang.web.md           # Nur im Web-Build → wird zu anhang.md
├── druckversion.pdf.md     # Nur im PDF-Build → wird im Web ignoriert

• .web.md / .web.mdx: Die Datei wird beim Web-Build umbenannt (.web.md → .md). So kann eine Web-Version neben einer PDF-Version existieren.
• .pdf.md: Die Datei wird vom Web-Build komplett ignoriert. Sie ist nur für die PDF-Pipeline relevant.

index.mdx#

Eine Datei namens index.mdx (oder index.md) dient als Startseite des Ordners, in dem sie liegt. Die URL entspricht dem Ordnerpfad ohne Dateiname:

dokument/kapitel-1/index.mdx  →  /kapitel-1
dokument/kapitel-1/seite.mdx  →  /kapitel-1/seite

Dateiname → URL-Pfad#

Der Dateiname (ohne Endung) wird zum URL-Pfad:

Namensregeln#

• Verwende Kleinbuchstaben und Bindestriche als Trennzeichen: meine-neue-seite.mdx
• Vermeide Leerzeichen, Umlaute und Sonderzeichen in Dateinamen
• Der Dateiname muss als Schlüssel in der _meta.yaml / _meta.ts referenziert werden (ohne Endung)

_meta-Dateien#

assets-Ordner#

Bilder und Medien gehören in den assets-Ordner. Relative Pfade in Markdown-Dateien werden beim Build automatisch umgeschrieben:

Wird im Build zu: