Frontmatter

Todo archivo MDX comienza con un bloque YAML entre marcadores ---. Estos metadatos controlan el título de la página, la apariencia en la barra lateral y cómo se muestra la página al compartirla en redes sociales o en resultados de búsqueda.

Frontmatter Básico

Cada página necesita al menos un título:

---
title: Getting Started
description: Learn the basics in 5 minutes
---

Campos Disponibles

Obligatorios

Campo	Tipo	Descripción
`title`	string	Título de la página mostrado en la navegación y en la pestaña del navegador

Campo	Tipo	Descripción
`description`	string	Resumen breve para SEO y resultados de búsqueda (50-160 caracteres)

Opcionales

Campo	Tipo	Predeterminado	Descripción
`icon`	string	-	Icono de Font Awesome mostrado junto al título en la barra lateral
`sidebarTitle`	string	`title`	Título más corto para la barra lateral
`mode`	string	-	Establecer en `"wide"` para diseño de ancho completo
`hideFooter`	boolean	`false`	Ocultar el pie de página social en esta página
`rss`	boolean	`false`	Habilitar la generación de feed RSS desde los componentes Update en esta página
`private`	boolean	`false`	Requiere la contraseña del sitio para ver esta página. Establecerlo en cualquier página activa el modo de páginas específicas en el siguiente build.
`public`	boolean	`false`	Exime esta página de la protección por contraseña (se usa cuando todo el sitio está restringido mediante `auth.password.enabled`). Tiene prioridad sobre `private: true` si ambos están configurados.

Controla cómo aparece la página en resultados de búsqueda y previsualizaciones sociales. Establece estos valores como claves planas de nivel superior o bajo un bloque seo: anidado. Ambas formas funcionan, y los valores por página anulan los predeterminados de seo.metatags en docs.json.

Campo	Tipo	Predeterminado	Descripción
`keywords`	string[]	-	Palabras clave de búsqueda, emitidas como etiqueta `<meta name="keywords">`
`canonical`	string	auto	URL canónica de esta página, anulando la generada automáticamente
`noindex`	boolean	`false`	Excluir esta página de los motores de búsqueda y del sitemap
`og:` / `twitter:`	string	-	Etiquetas de previsualización social de Open Graph y Twitter/X (p. ej. `og:title`, `og:image`, `twitter:card`)
`seo`	object	-	Bloque anidado que contiene cualquiera de los anteriores más metaetiquetas personalizadas

---
title: API Reference
description: REST endpoints and authentication
"og:image": /images/api-card.png
"twitter:card": summary_large_image
canonical: https://docs.acme.com/api-reference
---

Consulta Optimización SEO para la lista completa de etiquetas compatibles y ejemplos.

Ejemplos

Página de Documentación Estándar

---
title: Authentication
description: Secure your API with OAuth 2.0 and API keys
icon: lock
---

Título Largo con Anulación de Barra Lateral

---
title: Configuring Single Sign-On with SAML 2.0
sidebarTitle: SSO Setup
description: Set up enterprise SSO for your organization
---

El título completo aparece en la página, mientras que el sidebarTitle más corto mantiene la navegación ordenada.

Diseño Amplio

---
title: API Reference
description: Complete API documentation
mode: wide
---

El modo wide elimina la tabla de contenidos y expande el contenido al ancho completo. Útil para páginas de referencia de API o contenido con tablas anchas.

Ocultar Pie de Página

---
title: Custom Landing
description: A focused landing page experience
hideFooter: true
---

Usa hideFooter para páginas de destino, páginas de changelog o cualquier página donde desees una sección inferior más limpia sin enlaces sociales.

Buenas Prácticas de SEO

Tu título aparece en:

Pestañas del navegador
Resultados de motores de búsqueda
Barra lateral de navegación
Compartidos en redes sociales

Mantén los títulos por debajo de 60 caracteres. Coloca las palabras clave importantes al inicio.

# Good - clear and keyword-rich
title: Deploy to Production

# Avoid - vague or too long
title: How to Deploy Your Application to Production Servers

Las descripciones aparecen en resultados de búsqueda y previsualizaciones sociales. Apunta a 50-160 caracteres que:

Resuman el contenido de la página
Incluyan palabras clave relevantes
Inviten a los usuarios a hacer clic

# Good - actionable and specific
description: Deploy your docs to production in under 2 minutes with zero configuration

# Avoid - generic or missing
description: Documentation page

Los iconos ayudan a los usuarios a explorar la navegación rápidamente. Usa el mismo icono para páginas relacionadas:

Tema	Icono sugerido
Inicio	`rocket`
Autenticación	`lock`
Referencia de API	`code`
Configuración	`gear`
Facturación	`credit-card`

Explora iconos en Font Awesome.

Validación

Jamdesk valida el frontmatter al hacer el build. Errores comunes:

Error: Page "api/auth.mdx" is missing required field: title

Solución: Agrega el campo title a tu frontmatter.

Error: Invalid frontmatter in "guide.mdx": unexpected token

Solución: Verifica:

Comillas faltantes alrededor de strings con caracteres especiales
Indentación incorrecta
Dos puntos faltantes después de las claves

¿Qué sigue?

Optimización SEO

Optimiza tu documentación para los motores de búsqueda

Conceptos básicos de MDX

Aprende los fundamentos de MDX