Gestión de la documentación

Las documentaciones son contenedores de páginas de documentación. Cada tema importante de tu proyecto debe estar contenido en una documentación.

Administrar secciones

Las secciones de documentación y las referencias de API se encuentran en la misma página Administrar secciones. Para abrirla:

• En la navegación superior del editor, haz clic en el menú de secciones.

• Haz clic en el engranaje de configuración .

La lista de la izquierda agrupa las secciones bajo los encabezados Documentación y Referencia de API. Selecciona una sección de documentación para ver y editar su configuración a la derecha.

Crear una documentación

Para crear una documentación:

1. Abre el menú de secciones en la navegación superior.

2. En el grupo Documentación, haz clic en + Nueva documentación.

3. Asígnale un título.

Publicar una documentación

De forma predeterminada, las documentaciones no están publicadas. Para publicar (o anular la publicación):

• Abre Administrar secciones.

• Selecciona la documentación.

• Usa el botón Publicar / Anular publicación del encabezado.

Cuando se anula la publicación de una documentación, aparece una etiqueta Unpublished en el menú de secciones y en la lista de Administrar secciones.

Exportar una documentación como PDF

Administrar secciones tiene una tarjeta Exportar con un botón Exportar como PDF. Abre el panel Exportación a PDF con solo esa sección de documentación seleccionada, de modo que puedas entregar a alguien un PDF de una sola sección en lugar de toda la versión.

Eliminar una documentación

Para eliminar una documentación:

• Abre Administrar secciones.

• Selecciona la documentación.

• En la tarjeta Zona de peligro, haz clic en Eliminar sección.

• Confirma la eliminación.

Ordenar la documentación

Para cambiar el orden de una documentación en el selector:

• Abre Administrar secciones.

• Arrastra la documentación en la lista de la izquierda desde el control .

• Suelta la documentación en el lugar deseado.

Solo puedes reordenar dentro del grupo Documentación; no se admite arrastrar y soltar entre Documentación y Referencia de API.

Si la documentación está en primer lugar y está publicada, será la documentación que se cargue de forma predeterminada para tus lectores.