Cada página es un archivo MDX, que combina contenido en Markdown con componentes de React para que puedas crear documentación rica e interactiva.
Cada página comienza con frontmatter, la metadata en YAML delimitada por --- al inicio de un archivo. Esta metadata define cómo se muestra y cómo se comporta tu página.
Usa la metadata para controlar:
- Títulos y descripciones de la página
- Títulos, iconos y tags de la barra lateral
El título de tu página que aparece en la navigation y en las pestañas del navegador.
Una breve descripción de lo que trata esta página. Aparece debajo del título y mejora el SEO (Search Engine Optimization).
Un título breve que se muestra en la navigation de la barra lateral.
El icono que se mostrará.Opciones: El estilo de icono de Font Awesome. Solo se usa con iconos de Font Awesome.Opciones: regular, solid, light, thin, sharp-solid, duotone, brands. Un tag que aparece junto al título de tu página en la barra lateral.
mode.
Si no se define un modo, se utiliza por defecto un diseño estándar con una navigation lateral y una tabla de contenido.
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.
El modo personalizado ofrece un diseño minimalista que elimina todos los elementos excepto la barra superior. Es un lienzo en blanco para crear páginas de destino u otros diseños únicos en los que quieras mantener al mínimo los elementos de navigation. El modo personalizado está disponible para todos los temas.
El modo Frame ofrece un diseño similar al modo personalizado, pero conserva la navegación de 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.
El modo centrado elimina la barra lateral y la tabla de contenidos y centra el contenido. Es útil para páginas de cambios u otras en las que quieras destacar el contenido. El modo centrado está disponible en los temas Mint y Linden.
Crea áreas de pruebas de la API interactivas añadiendo una especificación de la API a tu frontmatter, api u openapi.
Obtén más información sobre cómo crear documentación de API.
Vincula sitios externos directamente desde tu navigation con la metadata url.
Optimización para motores de búsqueda
Las metaetiquetas con dos puntos deben ir entre comillas.
Palabras clave de búsqueda interna
keywords en tu metadata. Estas palabras clave no aparecerán en el contenido de la página ni en los resultados de búsqueda, pero si los usuarios las buscan, se mostrará la página como resultado.
