Frontmatter

Le frontmatter est un bloc de métadonnées YAML/TOML/JSON placé en tête d'un document, délimité par ---, couramment utilisé par les générateurs de sites statiques.

Objectif

Joindre des métadonnées structurées avant le corps d'un document de type Markdown, facilitant la génération du site et la gestion du contenu.

Mécanisme

Le document commence par ---, suivi de métadonnées YAML (ou TOML/JSON), se termine par ---, et le corps suit. L'analyseur sépare le frontmatter du corps. Jekyll, Hugo et Astro l'utilisent largement.

Cas d’usage

Métadonnées d'articles Astro/Hugo/Jekyll
Frontmatter de blogs Markdown
Configuration de sites de documentation
Gestion de contenu CMS

Exemples

entrée

---
title: Hello
---
# Body

Output

meta {title:"Hello"} + body

YAML frontmatter

Erreurs courantes

A frontmatter syntax error breaks parsing: Check it with a validator for the corresponding format

Termes associés

YAML (YAML Ain't Markup Language) est un format de sérialisation de données orienté configuration utilisant l'indentation pour la hiérarchie, prenant en charge commentaires et références, et mieux adapté à l'édition manuelle que JSON.

TOML (Tom's Obvious, Minimal Language) est un format orienté configuration qui représente les données avec des tables et des paires clé-valeur, à sémantique explicite et sans inférence de types implicite.

JSON (JavaScript Object Notation) est un format léger d'échange de données fondé sur les littéraux d'objets JavaScript, utilisant paires clé-valeur et tableaux.

YAML Frontmatter

Le frontmatter YAML est le bloc YAML délimité par --- en tête d'un fichier Markdown qui stocke les métadonnées du document (titre, date, tags).

References