Configura la navegación de tu sitio de documentación con grupos, páginas, menús desplegables y pestañas en docs.json para crear una estructura de barra lateral.
La propiedad navigation en docs.json controla la estructura y la jerarquía de información de tu documentación.Con una configuración de navegación adecuada, puedes organizar tu contenido para que los usuarios encuentren exactamente lo que están buscando.Elige un único patrón de organización principal para el nivel raíz de tu navegación. Una vez que hayas elegido tu patrón principal, puedes anidar otros elementos de navegación dentro de él.
Las páginas son el componente más fundamental de la navegación. Cada página es un archivo MDX en el repositorio de tu documentación.En el objeto navigation, pages es un array donde cada entrada debe hacer referencia a la ruta de un archivo de página.
Usa grupos para organizar la navegación de la barra lateral en secciones. Puedes anidar grupos entre sí, etiquetarlos con etiquetas y aplicar estilos con iconos.En el objeto navigation, groups es un array en el que cada entrada es un objeto que requiere un campo group y un campo pages. Los campos icon, tag, root y expanded son opcionales.
Usa la propiedad root para designar una página principal para un grupo. Cuando un grupo tiene una página raíz, al hacer clic en el título del grupo en la barra lateral de navegación se abre la página raíz. Las páginas raíz funcionan tanto para grupos de nivel superior como para grupos anidados.
Usa la propiedad expanded para controlar el estado predeterminado de un grupo anidado en la barra lateral de navigation.
expanded: true: el grupo se muestra expandido de forma predeterminada.
expanded: false o si se omite: el grupo se muestra contraído de forma predeterminada.
La propiedad expanded solo afecta a los grupos anidados (grupos dentro de otros grupos). Los grupos de nivel superior siempre están expandidos y no se pueden contraer.
Las Tabs crean secciones diferenciadas de tu documentación con rutas de URL independientes. Las Tabs generan una barra de navegación horizontal en la parte superior de tu documentación que permite a los usuarios cambiar entre secciones.En el objeto navigation, tabs es un array donde cada entrada es un objeto que requiere un campo tab y puede contener otros campos de navegación como groups, pages, icon o enlaces a páginas externas.
Los menús añaden elementos de navegación desplegables a una Tab. Usa los menús para ayudar a los usuarios a ir directamente a páginas específicas dentro de una Tab.En el objeto navigation, menu es un array donde cada entrada es un objeto que requiere un campo item y puede incluir otros campos de navegación como groups, pages, icon o enlaces a páginas externas.Los elementos de menú solo pueden contener groups, pages y enlaces externos.
Las anclas añaden elementos de navegación persistentes en la parte superior de tu barra lateral. Usa anclas para dividir tu contenido, ofrecer acceso rápido a recursos externos o crear llamadas a la acción destacadas.En el objeto navigation, anchors es un array donde cada entrada es un objeto que requiere un campo anchor y puede contener otros campos de navegación como groups, pages, icons o enlaces a páginas externas.
Usa anclajes globales para enlaces que deben aparecer en todas las páginas, independientemente de qué sección de tu navigation esté viendo el usuario. Los anclajes globales son especialmente útiles para vincular recursos fuera de tu documentación, como un blog, un foro de la comunidad o un portal de soporte, o para proporcionar un acceso coherente a páginas internas importantes (como una página de cambios o de estado).Los anclajes globales admiten tanto URL externas como rutas relativas a páginas dentro de tu documentación.
Los productos crean una sección de navegación dedicada para organizar la documentación específica de cada producto. Usa productos para separar distintas ofertas, servicios o conjuntos de funciones principales dentro de tu documentación.En el objeto navigation, products es un arreglo donde cada entrada es un objeto que requiere un campo product y puede contener otros campos de navegación como groups, pages, icons o enlaces a páginas externas.
{ "navigation": { "products": [ { "product": "Core API", "description": "Descripción de la API principal", "icon": "api", "groups": [ { "group": "Primeros pasos", "pages": [ "core-api/quickstart", "core-api/authentication" ] }, { "group": "Endpoints", "pages": [ "core-api/users", "core-api/orders" ] } ] }, { "product": "Plataforma de Analytics", "description": "Descripción de la Plataforma de Analytics", "icon": "chart-bar", "pages": [ "analytics/overview", "analytics/dashboard", "analytics/reports" ] }, { "product": "SDK móvil", "description": "Descripción del SDK móvil", "icon": "smartphone", "href": "https://mobile-sdk-docs.example.com" } ] }}
Los menús desplegables constituyen un menú desplegable en la parte superior de la barra lateral de tu navigation. Cada elemento de un menú desplegable dirige a una sección de tu documentación.En el objeto navigation, dropdowns es un array donde cada entrada es un objeto que requiere un campo dropdown y puede contener otros campos de navegación como groups, pages, icons o enlaces a páginas externas.
Integra especificaciones de OpenAPI directamente en la estructura de navegación para generar automáticamente la documentación de tu API. Crea secciones de API dedicadas o coloca páginas de endpoints dentro de otros componentes de navegación.Configura una especificación de OpenAPI predeterminada en cualquier nivel de tu jerarquía de navegación. Los elementos secundarios heredan la especificación a menos que definan la suya propia.
Cuando agregas la propiedad openapi a un elemento de navegación (como un anchor, tab o group) sin especificar ninguna página, Mintlify genera automáticamente páginas para todos los endpoints definidos en tu especificación de OpenAPI.Para controlar qué endpoints aparecen, enumera explícitamente los endpoints deseados en un arreglo pages.
Para obtener más información sobre cómo hacer referencia a endpoints de OpenAPI en tu documentación, consulta la sección Configuración de OpenAPI.
Divide tu navigation en diferentes versiones. Puedes seleccionar la versión desde un menú desplegable.En el objeto navigation, versions es un array en el que cada entrada es un objeto que requiere un campo version y puede contener cualquier otro campo de navegación.
Mintlify usa la primera versión del array versions como predeterminada. Usa el campo default para especificar una versión diferente como predeterminada.
Agrega una insignia a las entradas de versión en el menú desplegable del selector de versiones usando el campo opcional tag. Usa etiquetas para resaltar versiones específicas como «Última», «Recomendada» o «Beta».
Divide tu navegación en diferentes idiomas. Los idiomas se pueden seleccionar desde un menú desplegable.En el objeto navigation, languages es un array donde cada entrada es un objeto que requiere un campo language y puede contener cualquier otro campo de navegación, incluidas configuraciones de banner, footer y navbar específicas por idioma.Actualmente ofrecemos compatibilidad con los siguientes idiomas para la localización:
Puedes anidar elementos de navigation entre sí para crear jerarquías complejas. Debes tener un elemento principal de navigation en el nivel raíz, como pestañas, grupos o un menú desplegable. Puedes anidar otros tipos de elementos de navigation dentro de tu patrón principal de navigation.Cada elemento de navigation puede contener un solo tipo de elemento hijo en cada nivel de tu jerarquía de navigation. Por ejemplo, una pestaña puede contener elementos de anclaje que contienen grupos, pero una pestaña no puede contener tanto elementos de anclaje como grupos en el mismo nivel.
Las migas de pan muestran la ruta completa de navegación en la parte superior de las páginas. Algunos temas las traen habilitadas de forma predeterminada y otros no. Puedes controlar si las migas de pan se muestran en tu sitio usando la propiedad styling en tu docs.json.
Cuando un usuario expande un grupo de navigation, algunos temas navegan automáticamente a la primera página del grupo. Puedes anular el comportamiento predeterminado del tema usando la opción drilldown.
Configúralo en true para forzar la navegación automática a la primera página cuando un usuario selecciona un grupo de navigation.
Configúralo en false para evitar la navegación y solo expandir o contraer el grupo cuando un usuario selecciona un grupo de navigation.
Déjalo sin configurar para usar el comportamiento predeterminado del tema.
"interaction": { "drilldown": true // Forzar la navegación a la primera página cuando un usuario expande un menú desplegable}
