Saltar al contenido principal
Cada página es un archivo Markdown. Puedes usar tipos de archivo .mdx o .md para tus páginas. Recomendamos MDX, que combina Markdown con componentes de React para crear documentación enriquecida e interactiva. El Markdown plano (.md) puede agilizar la migración desde otras plataformas, pero cambiar a MDX habilita más funcionalidades.

​
Metadatos de la página

Cada página comienza con frontmatter, los metadatos YAML delimitados por --- al inicio de un archivo. Estos metadatos controlan cómo aparece y se comporta tu página. Usa el frontmatter para controlar:
  • Títulos y descripciones de la página
  • Títulos de la barra lateral, iconos y etiquetas
  • Diseños de página
  • Metatags de SEO
  • Metadatos personalizados
​
title
string
requerido
El título de tu página que aparece en la navegación y en las pestañas del navegador.
​
description
string
Una breve descripción de lo que cubre esta página. Aparece debajo del título y mejora el SEO.
​
sidebarTitle
string
Un título corto que se muestra en la navegación de la barra lateral.
​
icon
string
El icono que se mostrará.Opciones:
​
iconType
string
Solo para iconos de Font Awesome. El estilo del icono.Opciones: regular, solid, light, thin, sharp-solid, duotone, brands.
​
tag
string
Una etiqueta que aparece junto al título de tu página en la barra lateral.
​
hidden
boolean
Establécelo en true para eliminar la página de la navegación de la barra lateral. Los usuarios aún pueden acceder a la página mediante su URL, pero los motores de búsqueda no la indexan. Consulta Páginas ocultas para más detalles.
​
noindex
boolean
Establécelo en true para evitar que los motores de búsqueda indexen la página. Consulta Deshabilitar la indexación para más detalles. Todas las páginas con hidden: true en su frontmatter reciben noindex: true automáticamente.
​
<custom>
string
Cualquier frontmatter YAML válido. Por ejemplo, product: "API" o version: "1.0.0".
Example YAML frontmatter
---
title: "Acerca del frontmatter"
description: "El frontmatter son los metadatos que controlan cómo aparece y se comporta tu página"
sidebarTitle: "Frontmatter"
icon: "book"
tag: "NEW"
---

​
Modo de página

Controla el diseño de tu página con el ajuste mode.

​
Predeterminado

Si no defines ningún modo, la página utiliza un diseño estándar con una barra lateral de navegación y una tabla de contenidos. 
---
title: "Título de página predeterminado"
---

​
Ancho

El modo ancho oculta la tabla de contenidos. Utiliza este modo para páginas sin encabezados o si quieres contar con espacio horizontal adicional. El modo ancho está disponible en todos los temas. 
---
title: "Título de página amplia"
mode: "wide"
---

​
Personalizado

El modo personalizado ofrece un diseño minimalista y elimina todos los elementos excepto la barra de navegación superior. Considera el modo personalizado como un lienzo en blanco para crear páginas de destino o diseños únicos con una navegación mínima. Todos los temas son compatibles con el modo personalizado. 
---
title: "Título de página personalizado"
mode: "custom"
---
La propiedad style en las páginas con modo personalizado puede provocar un cambio en el diseño al cargar la página. Para evitar este problema, utiliza preferentemente Tailwind CSS o CSS personalizado.

​
Frame

El modo Frame ofrece un diseño similar al modo personalizado, pero mantiene la barra lateral de navegación. Usa este modo para incluir HTML y componentes personalizados mientras preservas la experiencia de navegación predeterminada. Solo los temas Aspen y Almond son compatibles con el modo Frame. 
---
title: "Título de página Frame"
mode: "frame"
---

​
Center

El modo Center elimina la barra lateral y la tabla de contenidos, centrando el contenido. Usa el modo Center para las páginas de cambios u otras páginas donde quieras centrar la atención en el contenido. Los temas Mint y Linden son compatibles con el modo Center. 
---
title: "Centrar título de página"
mode: "center"
---

​
Páginas de la API

Para crear un área de pruebas de la API interactiva, añade una especificación de la API a tu frontmatter configurando api o openapi. 
---
openapi: "GET /endpoint"
---
Obtén más información sobre cómo crear documentación de API. Enlaza a sitios externos directamente desde tu navigation con la metadata url. 
---
title: "Paquete npm"
url: "https://www.npmjs.com/package/mint"
---

​
Optimización para motores de búsqueda (SEO)

Mintlify genera automáticamente la mayoría de las metaetiquetas de SEO. Puedes establecer manualmente las metaetiquetas de SEO para personalizar tu estrategia de SEO, la difusión en redes sociales y la compatibilidad con los navegadores.
Envuelve siempre entre comillas las metaetiquetas que incluyan dos puntos.
---
"twitter:image": "/images/social-preview.jpg"
---
Consulta SEO para conocer todas las opciones de metadata de SEO.

​
Palabras clave para la búsqueda interna

Ayuda a los usuarios a descubrir una página específica en los resultados de búsqueda añadiendo keywords en tu metadata. Estas palabras clave no aparecen en el contenido de la página. Si los usuarios buscan esas palabras clave, la página aparecerá en los resultados de búsqueda. 
---
keywords: ['configuración', 'configuración inicial', 'primeros pasos']
---

​
Marca de tiempo de la última modificación

Muestra una marca de tiempo «Última modificación el [fecha]» en todas las páginas activando metadata.timestamp en tu configuración global.
docs.json
"metadata": {
  "timestamp": true
}
Para anular la configuración global de la marca de tiempo en una página individual, usa el campo timestamp del frontmatter. Usa este campo para mostrar u ocultar las marcas de tiempo en páginas específicas. 
---
title: "Título de la página"
timestamp: false
---
Si estableces timestamp: true, la página siempre muestra la marca de tiempo aunque la configuración global sea false. Si estableces timestamp: false, la página oculta la marca de tiempo aunque la configuración global sea true.