Frontmatter
Frontmatter ist ein YAML/TOML/JSON-Metadatenblock am Anfang eines Dokuments, begrenzt durch ---, der häufig von statischen Website-Generatoren verwendet wird.
Zweck
Strukturierte Metadaten vor dem Hauptteil eines Markdown-ähnlichen Dokuments anfügen und so Website-Erzeugung und Content-Verwaltung erleichtern.
Mechanismus
Das Dokument beginnt mit ---, gefolgt von YAML- (oder TOML/JSON-)Metadaten, endet mit ---, und der Hauptteil folgt. Der Parser trennt Frontmatter und Hauptteil. Jekyll, Hugo und Astro nutzen es verbreitet.
Anwendungsfälle
- Artikel-Metadaten in Astro/Hugo/Jekyll
- Markdown-Blog-Frontmatter
- Konfiguration von Dokumentationsseiten
- CMS-Content-Verwaltung
Beispiele
- Eingabe
--- title: Hello --- # BodyOutputmeta {title:"Hello"} + bodyYAML frontmatter
Häufige Fehler
- A frontmatter syntax error breaks parsing
- Check it with a validator for the corresponding format
Verwandte Begriffe
YAML
YAML (YAML Ain't Markup Language) ist ein konfigurationsorientiertes Datenserialisierungsformat, das Einrückungen für die Hierarchie nutzt, Kommentare und Referenzen unterstützt und besser für manuelle Bearbeitung geeignet ist als JSON. GLOSSAR
TOML
TOML (Tom's Obvious, Minimal Language) ist ein konfigurationsorientiertes Format, das Daten mit Tabellen und Schlüssel-Wert-Paaren darstellt, mit expliziter Semantik und ohne implizite Typinferenz. GLOSSAR
JSON
JSON (JavaScript Object Notation) ist ein leichtgewichtiges Datenaustauschformat auf Basis von JavaScript-Objektliteralen, das Schlüssel-Wert-Paare und Arrays nutzt. GLOSSAR
YAML Frontmatter
YAML-Frontmatter ist der mit --- begrenzte YAML-Block am Anfang einer Markdown-Datei, der die Metadaten des Dokuments (Titel, Datum, Tags) speichert. GLOSSAR