Zum Inhalt springen
uencoder

YAML Frontmatter

YAML-Frontmatter ist der mit --- begrenzte YAML-Block am Anfang einer Markdown-Datei, der die Metadaten des Dokuments (Titel, Datum, Tags) speichert.

Zweck

Strukturierte Metadaten in Markdown-Dokumente einbetten, damit statische Website-Generatoren (Hugo, Jekyll) Seiteneigenschaften extrahieren können.

Mechanismus

Die Datei beginnt mit ---, das einen YAML-Block öffnet, ein zweites --- schließt ihn, danach folgt der Markdown-Körper. Der Parser trennt die YAML-Metadaten vom Markdown-Inhalt, und die Metadaten werden als Objekt geparst.

Anwendungsfälle

  • Statische Website-Generatoren
  • Metadaten von Blogbeiträgen
  • Dokumentationsseiten

Verwandte Tools

References