Configuración de la documentación

Cada documentación puede tener una configuración distinta. Estos ajustes afectan a su funcionamiento. También se puede controlar el estado de publicación de la documentación.

Obsolescencia (11 dic 2023)

El diseño mínimo ya no es compatible. Solo está disponible el diseño ancho. Además, el índice siempre se puede desplazar.

Descripción

Puede establecer manualmente una descripción para su documentación. Los motores de búsqueda leerán la descripción y se mostrará en los resultados de búsqueda. Para establecer la descripción:

  • Abra Administrar secciones (menú de la sección → ajustes engranaje).

  • Seleccione la documentación.

  • Edite la descripción de la documentación.

Índice plegable

De forma predeterminada, el índice de su documentación aparece totalmente expandido. Esto significa que las páginas secundarias (páginas de segundo nivel) siempre se muestran.

Si su documentación tiene un índice largo, quizá le convenga configurarlo como plegable. Para ello:

  • Abra Administrar secciones (menú de la sección → ajustes engranaje).

  • Seleccione la documentación.

  • Marque la opción "Can parent pages indices collapse?".

Solo en modo en vivo

El índice siempre estará expandido en modo de edición. Este ajuste solo tiene efecto en modo en vivo.

Categorías plegables

De forma predeterminada, todas las categorías de su documentación aparecen expandidas.

Para cambiar este comportamiento y permitir que las categorías se plieguen:

  • Abra Administrar secciones (menú de la sección → ajustes engranaje).

  • Seleccione la documentación.

  • Marque "Can categories collapse?"

¿Alternar categorías manualmente?

Si desea que las categorías se puedan alternar manualmente, añada una etiqueta HEAD que contenga un script con window.settings.categoryToggle = true.

Mostrar última actualización de la página

Para que sus lectores puedan ver quién actualizó la página por última vez y cuándo, puede activar el ajuste Show Page Last Updated. Para ello:

  • Abra Administrar secciones (menú de la sección → ajustes engranaje).

  • Seleccione la documentación.

  • En la tarjeta Display, establezca Show last-updated en Disabled, Date & author o Date only.

Solo la fecha, mostrada al pie de la página

Copiar la documentación a una versión

Si es necesario, puede copiar una sección de documentación a una versión. El mismo slug de documentación no debe existir en la versión de destino. Para copiar la sección de documentación a una versión:

  • Abra Administrar secciones (menú de la sección → ajustes engranaje).

  • Seleccione la documentación.

  • Haga clic en Copy to Version y seleccione la versión.


  Última actualización