Guía Markdown de GitBook

GitBook es una herramienta online que te permitirá generar documentaciones y bases de conocimiento.

GitBook es un servicio que permite autogenerar bases de conocimiento y sitios web que incluyan la documentación de algún proyecto.

Acerca de GitBook

A diferencia de otros generadores de sitios web estáticos, podrás usar GitBook desde su interfaz web, usando un editor WYSIWYG. Si lo prefieres, también puedes editar los contenidos localmente y sincronizarlos con algún repositorio de GitHub. De esta forma podrás usar tu editor preferido. Para integrar un repositorio de GitHub con GitBook consulta este enlace.

Imagen de GitBook

A diferencia de otros generadores de documentación estáticos, como por ejemplo Docusaurus, GitBook se ocupará de todo el proceso de creación y también de la puesta en marcha, por lo que no tendrás que buscar un servicio de hosting para tu documentación. Con GitBook también podrás crear diferentes páginas web para luego organizarlas y publicarlas como un sitio web. Podrás usar tu propio dominio.

El editor de GitBook es un editor híbrido apto para cualquier usuario. Cuando introduzcas la sintaxis Markdown en el editor, se formateará automáticamente a medida que escribes. Si prefieres usar otro editor, siempre podrás copiar y pegar el código Markdown en el editor. Sin embargo, el editor es mejorable.

GitBook fue inicialmente un proyecto open source que podías usar desde tu sistema local. Sin embargo, el proyecto fue abandonado, creando un proyecto comercial online en su lugar. El caso es que todavía puedes descargar esta verisón de GitBook desde su repositorio.

Soporte Markdown

El soporte de GitBook con Markdown es bastante bueno, soportando casi todos los elementos de la sintaxis básica de Markdown y también la mayor parte de los elementos de la sintaxis extenida. En la lista que ves a continuación puedes ver los elementos de Markdown compatibles con GitBook:

Alternativas a GitBook

Algunas de las mejores alternativas a GitBook que también dispongan de una interfaz web podrían ser Squarespace o Ghost CMS.

Si tienes conocimientos más avanzados y prefieres generar la documentación del proyecto localmente, puedes usar Docusaurus o MkDocs.

Más información

Consulta los siguientes enlaces para obtener más información acerca de GitBook: