Saltar al contenido principal
Cada página es un archivo MDX que combina contenido Markdown con componentes de React para que puedas crear documentación rica e interactiva.

​
Metadatos de la página

Cada página comienza con frontmatter, los metadatos YAML delimitados por --- al inicio del archivo. Estos metadatos definen cómo se ve y se comporta tu página. Usa los metadatos para controlar:
  • Títulos y descripciones de la página
  • Títulos, íconos y etiquetas de la barra lateral
​
title
string
required
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 trata esta página. Aparece debajo del título y mejora el SEO.
​
sidebarTitle
string
Un título breve que se muestra en la navegación de la barra lateral.
​
icon
string
El ícono que se mostrará.Opciones:
​
iconType
string
El estilo del ícono de Font Awesome. Solo se usa con íconos de Font Awesome.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.
Ejemplo de frontmatter YAML
---
title: "Acerca del frontmatter"
description: "El frontmatter es la metadata que controla cómo se muestra y se comporta tu página"
sidebarTitle: "Frontmatter"
icon: "book"
tag: "NUEVO"
---

​
Modo de página

Controla cómo se muestra tu página con el ajuste mode.

​
Predeterminado

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

​
Ancho

El modo ancho oculta la tabla de contenidos. Es útil para páginas sin encabezados o si prefieres aprovechar el espacio horizontal adicional. El modo ancho está disponible en todos los temas. 
---
title: "Título de página ancho"
mode: "wide"
---

​
Personalizado

El modo Personalizado ofrece un diseño minimalista que elimina todos los elementos excepto la barra de navegación superior. Es un lienzo en blanco para crear páginas de aterrizaje u otros diseños únicos en los que quieras reducir al mínimo los elementos de navegación. El modo Personalizado está disponible para todos los temas. 
---
title: "Título de página personalizado"
mode: "custom"
---

​
Frame

El modo Frame ofrece un diseño similar al modo personalizado, pero conserva la navegación en la barra lateral. Este modo de página permite usar HTML y componentes personalizados mientras mantiene la experiencia de navegación predeterminada. El modo Frame solo está disponible en los temas Aspen y Almond. 
---
title: "Título de la página en marco"
mode: "frame"
---

​
Centrar

El modo Centrar elimina la barra lateral y la tabla de contenido, y centra el contenido. Resulta útil para registros de cambios u otras páginas en las que quieras destacar el contenido. El modo Centrar está disponible en los temas Mint y Linden. 
---
title: "Centrar título de la página"
mode: "center"
---

​
Páginas de API

Crea áreas de pruebas de API interactivas añadiendo una especificación de API al frontmatter, api o openapi. 
---
openapi: "GET /endpoint"
---
Obtén más información sobre cómo crear documentación de API. Enlaza sitios externos directamente desde la navegación con el metadato url. 
---
title: "Paquete npm"
url: "https://www.npmjs.com/package/mint"
---

​
Optimización para motores de búsqueda

La mayoría de las metaetiquetas de SEO se generan automáticamente. Puedes establecer metaetiquetas de SEO manualmente para mejorar el SEO de tu sitio, el intercambio en redes sociales y la compatibilidad con los navegadores.
Las metaetiquetas con dos puntos deben ir entre comillas.
---
"twitter:image": "/images/social-preview.jpg"
---
Consulta SEO para ver todas las opciones completas de metadatos de SEO.

​
Palabras clave de búsqueda interna

Mejora la capacidad de descubrimiento de una página específica en la búsqueda integrada proporcionando keywords en tus metadatos. Estas palabras clave no aparecerán como parte del contenido de la página ni en los resultados de búsqueda, pero los usuarios que las busquen verán la página como resultado. 
---
keywords: ['configuración', 'puesta en marcha', 'primeros pasos']
---