Pages
Conceptos básicos
Cada página es un archivo MDX que debe comenzar con --- al principio y al final. Esto se utiliza para definir los metadatos de la página, como el título y la descripción.
Por ejemplo, puedes definir el título de esta página de la siguiente manera.
Descripciones
Puedes agregar una descripción que muestre el resumen de la página debajo del título con el metadato description.
Título de la barra lateral
Si deseas mostrar un título diferente en la navegación, puedes establecer el metadato sidebarTitle. Esto es útil si tu título es largo y quieres algo más corto en los enlaces de navegación.
Iconos
Puedes establecer un icono para tu elemento de la barra lateral como el de esta página. Puedes establecer iconos utilizando el metadato icon.
Puedes establecer iconos de Font Awesome y Lucide, dependiendo de la configuración de la biblioteca de iconos.
También puedes establecer el tipo de icono para los iconos de Font Awesome (opcional). Si no se establece, el tipo de icono será regular.
Páginas de API
Las páginas de API te permiten construir áreas de juego interactivas para API. Para crear una página de API, debes establecer una propiedad api o openapi en los metadatos de la página.
Aprende más sobre las páginas de API visitando las guías de páginas de API.
Modo de página
La configuración del Modo de Página te permite personalizar la apariencia de tu página. Puedes elegir entre diferentes modos para ajustar el diseño según tus necesidades. Si no se especifica ningún modo, la página utilizará la configuración predeterminada.
Predeterminado
Si no se proporciona un modo específico, la página utilizará la configuración estándar por defecto. Esto significa que la página mostrará la tabla de contenidos predeterminada y otros elementos estándar.
Modo Ancho
En el Modo Ancho, puedes ocultar la tabla de contenidos (ToC) en el lado derecho de la página. Esto es particularmente útil si tu página no tiene encabezados o si prefieres utilizar el espacio horizontal adicional para más contenido.
Modo Personalizado
El Modo Personalizado proporciona un diseño minimalista eliminando todos los elementos excepto la barra superior. Este modo ofrece un lienzo en blanco, ideal para crear una “página de inicio” o cualquier página donde desees un entorno limpio y libre de distracciones.
Modo Centrado
El Modo Centrado elimina la barra lateral y la tabla de contenidos, y centra el contenido de la página. Este modo es excelente para registros de cambios o cualquier página donde quieras enfocarte en el contenido.
Enlaces externos
Si deseas que la barra lateral abra una URL externa, puedes establecer el metadato url en cualquier página.
Optimización para motores de búsqueda
Puedes establecer etiquetas meta como la imagen que se muestra cuando se comparte en redes sociales pasándolas a los metadatos de tu página.
Ten en cuenta que las etiquetas meta con dos puntos deben estar entre comillas.
Consulta SEO para obtener más información sobre los metadatos de SEO.
Optimización de búsqueda interna
También puedes mejorar la capacidad de descubrimiento de una página específica en la búsqueda incorporada 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.