Generadores de documentación estática
¡Hola comunidad!
En el pasado, la documentación técnica del código fuente y de los productos de software se generaba en archivos chm, pdf y generadores de documentación de los propios lenguajes de programación. Este enfoque antiguo tenía las siguientes limitaciones:
- Documentación obsoleta,
- Documentación no interactiva y difícil de consultar,
- Diseño poco amigable y que no se adhiere a HTML,
- Imposibilidad de personalizar el diseño de los documentos,
- Imposibilidad de tener documentación en HTML 5 online y offline.
- Falta de soporte a Markdown.
Hoy en día, existen varias soluciones de generación de documentación que producen Portales de Documentación Web muy atractivos, interactivos y con opciones estáticas y dinámicas, con soporte total para HTML 5 y más recientemente Markdown.
Consulta la tabla con las opciones de código abierto más populares:
Documentation Product | Stars |
MkDocs
|
11.4k |
Docsify Github Repo: https://github.com/docsifyjs/docsify
|
16.5k |
Docusaurus Github: https://github.com/facebook/docusaurus/
|
21.4k |
Slate Github: https://github.com/slatedocs/slate
|
31.9k |
GitBook
|
500,000 users |
La aplicación IRIS Publisher, en Open Exchange, permite extraer bloques de documentación XData en HTML o Markdown y generar un sitio web con la documentación de tu app, utilizando MkDocs. Consulta las instrucciones en el siguiente artículo de esta serie:
Cómo crear el Portal de Documentación para InterSystems IRIS