Repolode
star7th

star7th/showdoc

Herramienta de documentación en línea autohospedada para equipos de TI, centrada en documentación de API, diccionarios de datos y wikis de equipo en Markdown.

Alternativa open source a:ConfluenceNotion

Estrellas
12,872
Forks
2,212
Issues abiertos
235
Último commit
hace 4 días

¿Qué es?

ShowDoc es una herramienta web para compartir documentación, pensada para equipos de software. Busca resolver un problema habitual: cuando no hay documentación actualizada, a otras personas les cuesta retomar el código escrito por alguien más, y los documentos dispersos entre archivos de Word y mensajes de chat quedan obsoletos rápidamente.

Sus principales usos son la documentación de API, para la que permite crear rápidamente páginas de interfaces a partir de plantillas; los diccionarios de datos que describen los campos de una base de datos; y documentos generales de explicación o especificaciones técnicas. Las páginas se escriben en Markdown y cada una conserva un historial de versiones que permite restaurar versiones anteriores. Los proyectos pueden ser públicos o privados, transferirse entre propietarios y compartirse con miembros; además, se pueden exportar como documentos de Word para usar sin conexión.

ShowDoc se puede implementar en un servidor propio. La documentación del proyecto incluye una guía de instalación y una guía de seguridad para usuarios de Nginx y Apache.

Funciones clave

  • 01Plantillas integradas de interfaces de API y diccionarios de datos para crear páginas rápidamente.
  • 02Editor de Markdown con historial de versiones por página.
  • 03Proyectos públicos y privados con gestión de miembros y transferencia de propiedad.
  • 04Diseño adaptable para leer desde computadoras de escritorio y dispositivos móviles.
  • 05Exportación de proyectos como documentos de Word para usar sin conexión.
  • 06Se puede alojar en un servidor propio.

Casos de uso

  • Documentar API de backend para que los desarrolladores de frontend y dispositivos móviles puedan utilizarlas.
  • Mantener un diccionario de datos de una base de datos que explique cada campo.
  • Redactar instrucciones para herramientas internas o especificaciones técnicas para un equipo.
  • Retomar un proyecto heredado que carece de documentación escrita.

Inicio rápido

  1. 1

    Despliega el proyecto en tu propio servidor siguiendo la guía de AutoInstall

Antes de usarlo

  • Es necesario alojarlo en un servidor propio. Si usas Nginx o Apache, debes denegar el acceso al directorio Sqlite/ por seguridad.
  • Los metadatos indican NOASSERTION como licencia, y el README añade condiciones de derechos de autor adicionales a Apache 2.0 que exigen mantener los avisos de copyright y los enlaces en la interfaz.

En colecciones

Temas

Preguntas frecuentes

¿Qué es showdoc?
Herramienta de documentación en línea autohospedada para equipos de TI, centrada en documentación de API, diccionarios de datos y wikis de equipo en Markdown. ShowDoc es una herramienta web para compartir documentación, pensada para equipos de software. Busca resolver un problema habitual: cuando no hay documentación actualizada, a otras personas les cuesta retomar el código escrito por alguien más, y los documentos dispersos entre archivos de Word y mensajes de chat quedan obsoletos rápidamente.
¿showdoc es gratuito? ¿Qué licencia tiene?
showdoc es open source bajo la licencia Other. Revisa los términos de la licencia antes de usarlo en productos comerciales.
¿showdoc sigue mantenido?
Mantenimiento activo. El último commit de showdoc fue el 3 nov 2026.
¿Para qué puedo usar showdoc?
Documentar API de backend para que los desarrolladores de frontend y dispositivos móviles puedan utilizarlas. Mantener un diccionario de datos de una base de datos que explique cada campo. Redactar instrucciones para herramientas internas o especificaciones técnicas para un equipo. Retomar un proyecto heredado que carece de documentación escrita.
¿Cómo se instala showdoc?
Despliega el proyecto en tu propio servidor siguiendo la guía de AutoInstall
¿Dónde consigo showdoc?
El código fuente y las instrucciones de instalación están en GitHub: https://github.com/star7th/showdoc

Resumen generado por IA a partir del README del proyecto. Las estadísticas de GitHub se actualizan a diario.

Proyectos relacionados