YAML front matter: metadata bovenaan een Markdown-bestand

YAML front matter

YAML front matter in Markdown: syntax, velden en voorbeelden | We.Inc

Wat YAML front matter is, de regels voor ---, de velden die Jekyll, Hugo, Eleventy en Astro lezen, en een splitter die de metadata en de inhoud van uw eigen bestand toont.

Front matter is een blok YAML helemaal bovenaan een Markdown-bestand, geopend en gesloten door een regel met drie streepjes (---). Static site generators lezen het als de data van de pagina, zoals titel, datum, layout en tags, en renderen daarna alles onder de sluitregel als de inhoud van de pagina.

Ondersteuning voor front matter in vier populaire static site generators

Front matter maakt van een gewoon Markdown-bestand een pagina met metadata, en één verkeerd geplaatst streepje maakt het kapot. Plak een bestand in de splitter om precies te zien waar de metadata eindigt en de inhoud begint, en welke velden op het hoogste niveau gevonden zijn, voordat uw build gaat klagen.

Veelgestelde vragen

Wat is front matter in Markdown?

Het is metadata die bovenaan een Markdown-bestand tussen twee scheidingsregels staat. Markdown zelf definieert het niet; static site generators en contenttools hebben de conventie afgesproken en lezen het als data voordat ze de rest renderen.

Moet front matter YAML zijn?

YAML is de gangbare standaard, maar niet de enige optie. Hugo accepteert TOML tussen +++-regels en JSON tussen accolades, Eleventy ondersteunt ---json en ---js, en Astro accepteert ook TOML.

Waarom toont mijn pagina de front matter als tekst?

Meestal staat er iets vóór de eerste ---, ontbreekt de sluitende ---, of heeft de openingsregel extra tekens. De splitter hierboven signaleert de laatste twee meteen.

Mag front matter leeg zijn?

Ja. In Jekyll markeert een leeg paar ---regels het bestand toch voor verwerking, en zo krijgen CSS- of feedbestanden hun Liquid-tags gerenderd zonder enige metadata.

Hoe lees ik front matter in mijn eigen code?

Splits het bestand bij de scheidingstekens, parse het eerste deel met een YAML-library en geef de rest aan uw Markdown-renderer. Eleventy doet dit met het pakket gray-matter, dat u ook direct in Node kunt gebruiken.

De regels voor scheidingstekens

Velden die het waard zijn op elke pagina te zetten

Voorbeelden van front matter

Een blogpost (YAML)

Een typische post: titel tussen quotes omdat er een dubbele punt in staat, een datum, een lijst met tags en een eigen auteursveld.

Dezelfde post met TOML-front matter (Hugo)

Hugo leest +++ als TOML-front matter. Eigen waarden staan onder de params-key.

Front matter-splitter

Plak een Markdown-bestand. De splitter vindt het front matter-blok, somt de eenvoudige velden op het hoogste niveau op en toont de inhoud die gerenderd wordt.

Markdown-bestand

Front matter ({f})

Gevonden velden op het hoogste niveau

Geen eenvoudige key: value-regels op het hoogste niveau.

Inhoud

Geen front matter: de eerste regel is niet --- of +++, dus het hele bestand wordt als inhoud behandeld.

Het blok dat met {d} opent, wordt nooit gesloten. Voeg na het laatste veld een bijpassende {d}-regel toe.

Front matter gevonden en gesloten.

Veld

Waarde zoals geschreven

Gratis beginnen · Geen creditcard nodig

Gerelateerd: Gidsen

Product

Voor wie

Functies

Bronnen

Bedrijf

Sitemap