Saltar al contenido principal
La barra lateral de navegación controla cómo se organiza tu documentación. Los cambios que realices en el árbol de navegación del editor web aparecerán en la barra lateral de navegación de tu sitio y se sincronizarán con tu archivo de configuración docs.json.

​
Agregar elementos de navegación

Haz clic en el botón Add new en la parte inferior del árbol de navegación para agregar un nuevo elemento de navegación.
Agregar nuevo elemento de navegación.
Para agregar un elemento de navegación anidado dentro de otro elemento, haz clic en el botón + junto al nombre del elemento padre. Después de crear un elemento, arrástralo y suéltalo para reordenarlo o anidarlo dentro de otros elementos. Haz clic con el botón derecho en cualquier elemento para configurar sus propiedades, duplicarlo, ocultarlo de la navegación o eliminarlo.
Algunos elementos no se pueden anidar dentro de otros elementos. Por ejemplo, las pestañas no se pueden anidar dentro de groups. El editor web impide que anides elementos inválidos.

​
Organiza en secciones

Elige la estructura de navegación adecuada para el alcance y la audiencia de tu documentación.

​
Cuándo usar páginas

Usa páginas para archivos de documentación individuales. Las páginas son los componentes básicos de tu navigation: todo el contenido vive en una página. Agrega páginas a tu navigation para hacerlas visibles en la barra lateral de tu sitio. Las páginas pueden existir en el nivel raíz, dentro de groups, tabs, anchors, dropdowns o menús.

​
Cuándo usar grupos

Usa grupos para organizar páginas relacionadas en secciones contraíbles. Los grupos ayudan a los usuarios a explorar la navegación agrupando contenido similar, por ejemplo, todas las páginas relacionadas con Autenticación o todas las referencias de endpoints de la API. Los grupos se pueden anidar dentro de otros grupos para crear una organización jerárquica. Los grupos pueden existir dentro de Tabs, anchors, menús desplegables o en el nivel raíz.

​
Cuándo usar pestañas

Usa pestañas para crear secciones principales independientes con navegación horizontal en la parte superior de tu sitio. Las pestañas funcionan bien cuando tienes áreas diferenciadas como Referencia de API, Guías y SDKs entre las que los usuarios necesitan cambiar. Las pestañas pueden contener páginas, groups y elementos de menú. Configura las pestañas para agregar iconos o enlazar a recursos externos.

​
Cuándo usar anclas

Utiliza anclas para crear elementos de navegación persistentes en la parte superior de tu barra lateral. Las anclas son útiles cuando quieres dividir tu contenido en secciones o proporcionar acceso rápido a recursos externos sin cambiar de pestaña. Las anclas pueden contener páginas y groups, o enlazar a URLs externas. Anclas globales: Crea anclas globales que aparezcan en todas las páginas, independientemente de la sección que estén viendo los usuarios. Las anclas globales deben enlazar a URLs externas y son útiles para recursos como blogs, páginas de estado o enlaces de soporte.

​
Cuándo usar menús desplegables

Usa menús desplegables para crear un menú desplegable en la parte superior de la barra lateral. Los menús desplegables funcionan bien cuando tienes varias secciones relacionadas que los usuarios pueden querer explorar, pero que no necesitan estar siempre visibles como las pestañas. Los menús desplegables pueden contener páginas y grupos o enlazar a URL externas.

​
Cuándo usar menús

Usa menús para agregar elementos de navegación desplegables dentro de una Tab. Los menús ayudan a los usuarios a navegar directamente a páginas específicas desde la barra de navegación superior. Los menús pueden contener páginas y grupos.

​
Cuándo usar productos

Usa productos cuando tengas varios productos distintos que cada uno necesite su propia documentación. Los productos crean un menú selector que permite a los usuarios navegar entre diferentes conjuntos de documentación de producto. Cada producto puede tener su propia estructura de navegación con pestañas, páginas y groups.

​
Cuándo usar versiones

Usa versiones cuando mantienes varias versiones de tu documentación simultáneamente, como v1.0, v2.0 y v3.0 de una API. Las versiones crean un menú selector que permite a los usuarios elegir qué versión quieren ver. Cada versión puede tener contenido y una estructura de navegación diferentes.

​
Cuándo usar idiomas

Usa idiomas cuando ofrezcas documentación en varios idiomas. Los idiomas crean un menú de selección que permite a los usuarios ver la documentación en su idioma preferido. Cada idioma mantiene la misma estructura de navegación con contenido traducido.

​
Personalizar la apariencia

Agregar iconos:
  1. Haz clic con el botón derecho en un elemento de navegación.
  2. Haz clic en Configure.
  3. Haz clic en el campo icon.
Agregar etiquetas:
  1. Haz clic con el botón derecho en un elemento de navegación.
  2. Haz clic en Configure.
  3. Haz clic en el campo tag.
  4. Escribe una etiqueta como “NEW” o “BETA” que resalte elementos importantes.
Controlar la visibilidad: Oculta el contenido dentro de un elemento de navegación sin eliminarlo de tu repositorio.
  1. Haz clic con el botón derecho en cualquier elemento.
  2. Haz clic en el interruptor junto a la opción Hide.