Frontmatter

Actualizado el 12 nov 2026

El frontmatter YAML al principio de cada archivo .md añade metadatos a un artículo. Todos los campos son opcionales; cuando falta un campo, Livemark deriva valores por defecto razonables a partir del propio archivo.

---
title: Getting Started
description: Your first Livemark project, in ten minutes.
icon: rocket
order: 1
---

Metadatos del artículo

Identidad y presentación del artículo.

Campo	Tipo	Valor por defecto	Propósito
`title`	`string`	Primer encabezado `#`, si no, nombre de archivo	Título de la pestaña del navegador, encabezado del artículo, etiqueta de navegación.
`label`	`string`	`title`	Variante corta usada en la barra lateral y las migas de pan cuando `title` es largo.
`description`	`string`	—	`<meta name="description">` y descripción de Open Graph.
`icon`	`string`	—	Nombre de icono de Lucide (p. ej. `rocket`, `book-open`). Los artículos sin icono se renderizan sin icono.
`image`	`string`	—	Imagen de Open Graph / tarjeta social (requiere `site`). Las rutas relativas se resuelven desde el archivo.
`author`	`string \| string[]`	—	Uno o varios nombres de autor.
`date`	`string`	—	Fecha ISO. Determina el orden en las secciones de blog.
`tags`	`string[]`	—	Las secciones de blog lo usan para generar las páginas `<prefijo del blog>tags/<tag>/`, p. ej. `/blog/tags/release/`.

Cómo aparece el artículo en la navegación de la izquierda.

Campo	Tipo	Valor por defecto	Propósito
`order`	`number`	— (sin orden, en el medio)	Posición de orden. Consulta "Reglas de orden" más abajo.
`sidebar`	`boolean`	`true`	Si es false, el artículo es accesible por URL pero se oculta de la navegación.
`toc`	`boolean`	`true`	Si es false, oculta el índice de la derecha.
`breadcrumbs`	`boolean`	`breadcrumbs` de la configuración	Si es false, oculta la ruta sobre el título; true la muestra aunque la configuración la desactive.

Reglas de orden

order usa un esquema de dos regiones:

Un order positivo va primero, en orden ascendente (order: 1, 2, 3, …).
Los artículos sin order van después, en orden natural.
Un order negativo va al final, con -1 el último, -2 el penúltimo, etc.

Así puedes fijar "Primeros pasos" arriba (order: 1) y "Preguntas frecuentes" abajo (order: -1) sin tocar el resto.

URL

Campo	Tipo	Valor por defecto	Propósito
`path`	`string`	Las carpetas y el nombre en slug del archivo (ver abajo)	La URL del artículo. Las barras inicial y final se añaden si faltan.
`language`	`string`	Sufijo de archivo `.<code>.md`, si no, el idioma por defecto	El idioma del artículo en un sitio multilingüe.

Sin path, la URL sale de la ubicación del archivo bajo el inicio fijo del glob de include que lo encontró, docs/ para docs/**/*.md:

docs/guide/install.md → /guide/install/
docs/guide/index.md → /guide/, un archivo index toma el nombre de su carpeta
docs/index.md → /
docs/guide/install.es.md → /es/guide/install/, o el path del original bajo /es/ cuando install.md lo fija

Cada segmento se convierte en slug, así que docs/Getting Started.md pasa a ser /getting-started/. Dos artículos que acaban con la misma ruta hacen fallar la compilación, que nombra ambos archivos.

Enlace a la fuente

La barra de herramientas de la página enlaza cada artículo con su fuente. Sin sourceUrl, el enlace va a la página de edición del archivo en GitHub, leída del origin de git del proyecto y de su rama por defecto; un proyecto que no es un repositorio de GitHub no muestra enlace.

Campo	Tipo	Valor por defecto	Propósito
`sourceUrl`	`string`	La página de edición del archivo en GitHub	Adónde apunta el enlace a la fuente.
`sourceAction`	`"edit" \| "view"`	`"edit"`	Rotula el enlace Editar en GitHub con un lápiz, o Ver en GitHub con un ojo.

Formato

Campo	Tipo	Predeterminado	Propósito
`format`	`"md" \| "mdx"`	`"mdx"` para un archivo `.mdx`, si no `"md"`	Compila el cuerpo como Markdown simple, o como MDX.

El Markdown simple acepta cualquier texto: {…} se mantiene literal y el HTML en bruto se renderiza como HTML. MDX añade JSX y {expresiones}, así que una llave o un < sueltos en la prosa hacen fallar la compilación.

Sobrescribir sin editar

Si no puedes modificar el frontmatter de un archivo (por ejemplo, un README.md que también sirve de portada en GitHub), puedes inyectar los mismos campos desde livemark.config.ts mediante Article Patches.

Ver también

Article Sections — cómo interactúan order y date con las secciones de blog y de registro de cambios.
Article Patches — define el frontmatter desde la configuración, sin tocar el archivo.