Doctave

Doctave es una plataforma de documentación que combina la flexibilidad de escribir en Markdown con la potencia de un alojamiento profesional de documentación. Escribes tu documentación en archivos de texto plano, los almacenas en Git junto con tu código, y Doctave se encarga de convertirlos en sitios web de documentación hermosos y buscables.

La plataforma soporta tanto guías en Markdown como especificaciones OpenAPI para documentación de API. Crea automáticamente entornos de vista previa cuando realizas cambios, para que tu equipo pueda revisar las actualizaciones antes de publicarlas. Todo permanece en tu repositorio Git, dándote control total de versiones sobre tu documentación.

Doctave Studio es la aplicación de escritorio complementaria que ofrece vistas previas en tiempo real, sugerencias de autocompletado, verificación de enlaces rotos y corrección ortográfica. Juntas, estas herramientas ayudan a los equipos a crear documentación que se mantiene actualizada y precisa.

Comenzar con Doctave es sencillo. Aquí se explica cómo usarlo de manera efectiva:

• Crea una carpeta de documentación en tu repositorio de código y escribe tu contenido usando archivos Markdown. Incluye un archivo README.md como tu página de inicio.

• Instala Doctave Studio en tu computadora para previsualizar tu documentación localmente con actualizaciones en tiempo real mientras escribes.

• Configura tu archivo doctave.yml para definir la estructura de tu documentación, los colores del tema y los enlaces de navegación.

• Conecta tu repositorio Git a Doctave a través de su plataforma. Cada vez que hagas un push de cambios, Doctave actualizará automáticamente tu documentación publicada.

• Para la documentación de API, añade tu archivo de especificación OpenAPI a tu repositorio. Doctave generará automáticamente páginas interactivas de referencia de API.

• Usa ramas de Git para gestionar diferentes versiones de tu documentación. Crea pull requests para revisar los cambios antes de publicarlos, y Doctave generará enlaces de vista previa para cada pull request.

• Flujo de trabajo de documentación basado en Git con control de versiones

• Editor de escritorio Doctave Studio con vista previa en tiempo real

• Soporte para especificación OpenAPI para documentación de API

• Entornos de vista previa automáticos para pull requests

• Gestión de documentación multi-versión

• Búsqueda integrada en todo el contenido

• Opciones personalizadas de marca y temas

• Analíticas de lectores y recopilación de comentarios

• Integración CI/CD para despliegue automático

• Opciones de documentación protegida con contraseña