Frontmatter

El frontmatter es un bloque de metadatos YAML/TOML/JSON colocado al principio de un documento, delimitado por ---, usado comúnmente por los generadores de sitios estáticos.

Propósito

Adjuntar metadatos estructurados antes del cuerpo de un documento tipo Markdown, facilitando la generación del sitio y la gestión del contenido.

Mecanismo

El documento comienza con ---, seguido de metadatos YAML (o TOML/JSON), termina con --- y el cuerpo va a continuación. El analizador separa el frontmatter del cuerpo. Jekyll, Hugo y Astro lo usan ampliamente.

Casos de uso

Metadatos de artículos en Astro/Hugo/Jekyll
Frontmatter de blogs Markdown
Configuración de sitios de documentación
Gestión de contenido en CMS

Ejemplos

entrada

---
title: Hello
---
# Body

Output

meta {title:"Hello"} + body

YAML frontmatter

Errores comunes

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

Términos relacionados

YAML (YAML Ain't Markup Language) es un formato de serialización de datos orientado a configuración que usa indentación para la jerarquía, soporta comentarios y referencias, y se presta mejor a la edición manual que JSON.

TOML (Tom's Obvious, Minimal Language) es un formato orientado a configuración que representa datos con tablas y pares clave-valor, con semántica explícita y sin inferencia de tipos implícita.

JSON (JavaScript Object Notation) es un formato ligero de intercambio de datos basado en los literales de objeto de JavaScript, usando pares clave-valor y arrays.

YAML Frontmatter

El frontmatter YAML es el bloque YAML delimitado por --- al principio de un archivo Markdown que almacena los metadatos del documento (título, fecha, etiquetas).

References