Front matter en Markdown
Aprende a usar front matter con YAML y TOML para añadir metadatos a tus documentos Markdown
El front matter es un bloque de metadatos que se coloca al inicio de un archivo Markdown. Permite definir información como el título, la descripción, la fecha de publicación, etiquetas y cualquier otro dato que necesites asociar al documento.
Sintaxis YAML
La forma más habitual de front matter usa sintaxis YAML, delimitada por tres guiones (---):
---
title: Mi artículo
description: Una descripción del artículo
date: 2024-01-15
tags:
- markdown
- tutorial
draft: false
---
El contenido del artículo empieza aquí.Sintaxis TOML
Algunos generadores de sitios estáticos como Hugo usan TOML, delimitado por tres signos de suma (+++):
+++
title = "Mi artículo"
description = "Una descripción del artículo"
date = 2024-01-15
tags = ["markdown", "tutorial"]
draft = false
+++
El contenido del artículo empieza aquí.Campos comunes
| Campo | Descripción | Ejemplo |
|---|---|---|
title | Título del documento | "Mi artículo" |
description | Descripción o resumen | "Guía de Markdown" |
date | Fecha de publicación | 2024-01-15 |
tags | Etiquetas o categorías | [markdown, tutorial] |
draft | Borrador (no publicar) | true / false |
author | Autor del documento | "Eduardo" |
slug | URL personalizada | "mi-articulo" |
Herramientas que soportan front matter
Estas son las principales herramientas que soportan front matter:
- Jekyll: YAML front matter.
- Hugo: YAML, TOML y JSON.
- Gatsby: YAML front matter.
- Next.js: Con librerías como gray-matter.
- Docusaurus: YAML front matter.
- Obsidian: YAML front matter para metadatos de notas.
👋 Hola! Soy Edu, me encanta crear cosas y he redactado este tutorial. Si te ha resultado útil, el mayor favor que me podrías hacer es el de compatirlo en Twitter.
Sígueme en Twitter para estar al día con mi contenido. 😊
