Skip to main content

Site Tool

· 2 min read
David Puziol Prata
DevOps at @ Encora

Hola lectores,

Existen varias herramientas para escribir documentación de proyectos usando markdown.

Las principales que conozco son:

Lo que busco es crear un sitio estático sin aplicaciones ejecutándose en segundo plano, sin base de datos, solo páginas de lectura con mucha documentación y que sea fácil de respaldar y versionar.

gitbook

  • Es de pago si es colaborativo, es decir, es bueno para trabajar solo.
  • Precio alto por cada miembro del equipo ($6.70)
  • No necesitas gastar tiempo desplegando un sitio web
  • Interfaz en línea para alterar la documentación
  • Dominio personalizado

retype

  • No tiene costo hasta 100 páginas por proyecto o si se elimina el logo de retype.
  • Solo un proyecto gratuito por usuario
  • Número de colaboradores ilimitados en un proyecto
  • No necesitas gastar tiempo desplegando un sitio web
  • Dominio personalizado

docusaurus

  • Código Abierto: No existe ningún costo
  • Curva de aprendizaje un poco mayor, pero tiene una excelente documentación
  • No tiene una interfaz web para alteración. Todo cambio debe hacerse directamente en el código fuente editando los archivos markdown.
  • Mayor cantidad de recursos disponibles

Elegí Docusaurus porque puedo aceptar merge requests de otras personas y publicar directamente en el sitio usando Netlify

Más adelante haré una documentación sobre esto.