Docusaurus: Una excelente herramienta para documentar proyectos

Una de las tareas más importante a la hora de crear software es la documentación, lamentablemente para los que desarrollamos a veces esta labor nos parece tediosa, pero para nadie es un secreto que una buena documentación puede ser el punto de éxito de cualquier herramienta, ya sea por la ayuda que se le brinda a los usuarios para entender el correcto funcionamiento de la aplicación o la información que se le suministra a los demás desarrolladores para mejorarla.

Existen aplicaciones bastante buenas que nos permiten documentar nuestros proyectos de una manera sencilla, algunas tienden a ofrecer más de lo que realmente queremos y otras requieren de complejas instalaciones, una herramienta para documentar proyectos que cumple y es bastante sencilla de usar e instalar es Docusaurus.

¿Qué es Docusaurus?

Docusaurus es un proyecto para construir, implementar y mantener la documentación web de herramientas de código abierto, el mismo permite utilizar el lenguaje Markdown para escribir la documentación que luego será publicada como un sitio web html, de igual manera, la herramienta permite extender y personalizar el diseño de nuestro sitio web de documentación con el uso de React.

En líneas generales esta herramienta de código abierto desarrollada por el equipo de programación de Facebook, nos permite crear fácilmente sitios web bonitos y ligeros donde podemos mostrar adecuadamente la documentación de cualquier proyecto.

La herramienta está equipada con funcionalidades para el correcto versionamiento de los documentos, un avanzado buscador, la posibilidad de documentar y rediseñar nuestro sitio de documentación en tiempo real, integración con traducciones y muchas otras características que le ayudará a preocuparse menos por documentar o mejor dicho por hacer el proceso de documentación más sencillo y con acabado más agradable.

El fácil uso de Docusaurus se puede comprobar en el siguiente gif distribuido por sus desarrolladores

¿Cómo instalar Docusaurus?

Docusaurus tiene como objetivo principal ser la herramienta definitiva para documentar aplicaciones de código abierto alojadas en github, por lo que es realmente sencillo poder instalar y hacer andar tu sitio web de documentación en esta plataforma.

Para comenzar a disfrutar Docusaurus en Github basta con seguir los pasos indicados por el equipo de desarrollo y que citamos a continuación:

  1. Vaya a la raíz de su directorio de repositorio de GitHub donde va a crear los documentos y ejecute los siguientes comandos:
  2. yarn global add docusaurus-init or npm install --global docusaurus-init
  3. docusaurus-init

El resultado final será la creación de una estructura de archivos y directorios como se nos muestra a continuación:


Categorías

Aplicaciones, GNU/Linux

Lic. en Computación, Programador, Consultor ERP, Webmaster, Community Manager y apasionado por el Internet, tengo 8 años sumergido en el mundo del software libre, especializándome en el uso del software libre n las Empresas. La Libertad del Código es directamente proporcional al Crecimiento de una Organización

Un comentario

  1.   Juan José dijo

    Interesante bicho a probar!

Deja un comentario

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *

*

*

  1. Responsable de los datos: Miguel Ángel Gatón
  2. Finalidad de los datos: Controlar el SPAM, gestión de comentarios.
  3. Legitimación: Tu consentimiento
  4. Comunicación de los datos: No se comunicarán los datos a terceros salvo por obligación legal.
  5. Almacenamiento de los datos: Base de datos alojada en Occentus Networks (UE)
  6. Derechos: En cualquier momento puedes limitar, recuperar y borrar tu información.