Cada página es un archivo MDX que combina contenido Markdown con componentes de React para que puedas crear documentación rica e interactiva.
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
El título de tu página que aparece en la navegación 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.
Un título breve que se muestra en la navegación de la barra lateral.
El ícono que se mostrará.Opciones: El estilo del ícono de Font Awesome. Solo se usa con íconos de Font Awesome.Opciones: regular, solid, light, thin, sharp-solid, duotone, brands. Una etiqueta que aparece junto al título de tu página en la barra lateral.
Ejemplo de frontmatter YAML
mode.
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.
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 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.
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.
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.
Crea áreas de pruebas de API interactivas añadiendo una especificación de API al frontmatter, api o openapi.
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.
Optimización para motores de búsqueda
Las metaetiquetas con dos puntos deben ir entre comillas.
Palabras clave de búsqueda interna
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.
