GitBook crear documentación técnica con markdown y git

GitBook es una excelente herramienta para crear documentación de proyectos y libros técnicos usando Markdown y Git/Github. Permite incluir ejemplos y ejercicios interactivos (de momento, soporta solamente JavaScript) para posteriormente publicarlos de forma online via Github o cualquier otro hosting web.

Utilizando Markdown podemos maquetar los documentos y crearlos en distintos formatos como PDF, ebook o web. Uno de los objetivos de GitBook es poder crear documentación que sea fácilmente editable y abierta a contribuciones, por eso usando Git/Github podemos publicar nuestro libro técnico y manejar las colaboraciones de forma transparente.

GitBook está implementando usando node.js, podemos instalarlo usando NPM:

 $ npm install gitbook -g 

Podemos servir un libro directamente desde un repositorio con este comando:

 $ gitbook serve ./repository 

Los documentos se pueden exportar como sitio web independiente incluyendo ejemplos interactivos que pueden ser alojados directamente desde GitHub Pages, PDF con la solución de los ejercicios al final del libro, ebook utilizando además un conversor, formato Single Page o JSON para extraer metadatos del documento.

Cuenta con un editor de forma experimental para Windows, Mac y Linux que facilita la escritura en GitBook.

Algunos ejemplos de libros y documentación técnica creada con GitBook son Learn JavaScript, Learn Git o la documentación de Marionette.js.

Más información | GitBook


La noticia GitBook, crea documentación técnica y libros usando Markdown y Git/Github de forma flexible fue publicada originalmente en Genbetadev por Txema Rodríguez.




via Genbetadev http://red2.es/1iehwfe

Related Posts with Thumbnails
Tagged with:  

Comments are closed.

WordPress Blog