GitBook
O GitBook é uma ferramenta online que hospeda sites de documentação com suporte ao Markdown.
Visão geral
Por ser uma ferramenta online, o GitBook possui um editor Markdown que roda diretamente no seu navegador, assim, a ferramenta oferece bastante praticidade para você criar as suas documentações.
Se você precisa de mais controle sobre o seu conteúdo, o GitBook também oferece suporte a integração com repositórios do GitHub.
Com o GitBook você pode criar o seu site e posteriormente publicá-lo usando um domínio personalizado.
Mas vale ressaltar que, o GitBook começou como um projeto de código fonte aberto e tinha apenas uma pequena oferta comercial para angariar fundos para a empresa.
Hoje a ferramenta é fechada e proprietária, então, tenha isso em mente se pretende aderir ao uso do GitBook.
O projeto de código aberto ainda existe e pode ser usado por qualquer pessoa, mas o GitBook não fornece mais suporte a esse projeto, por isso serão listados apenas os elementos Markdown compatíveis com a ferramenta proprietária.
Mesmo sendo um aplicativo fechado o GitBook ainda possui vantagens sobre outras ferramentas do tipo.
Por exemplo, a construção e a hospedagem do site ficam a cargo do próprio programa.
O GitBook fornece um editor Markdown bem intuitivo, com controles WYSIWYG fáceis de usar.
Assim, até usuários novatos se sentem confortáveis editando documentos Markdown.
Outra característica interessante da ferramenta é a ocultação das marcações do Markdown enquanto você digita.
O editor pode parecer estranho a princípio, mas com o tempo você pega o jeito.
O GitBook também é compatível com o copiar e colar, pegue o seu conteúdo Markdown e cole diretamente na interface da ferramenta.
O site oficial do GitBook fica localizado no endereço https://www.gitbook.com/.
Suporte ao Markdown no GitBook
A Tabela 1.1 apresenta os elementos Markdown compatíveis com o GitBook.
| Elemento | Suporte | Informação |
|---|---|---|
| Títulos | Sim | |
| Parágrafos | Sim | |
| Quebras de linha | Sim | |
| Negrito | Sim | |
| Itálico | Sim | |
| Blockquote | Sim | |
| Listas ordenadas | Sim | |
| Listas não ordenadas | Sim | |
| Código | Sim | |
| Linhas horizontais | Não | |
| Links | Sim | |
| Imagens | Sim | |
| Tabelas | Sim | |
| Blocos de código cercado | Sim | Você também pode realçar a sintaxe da linguagem de programação do bloco. |
| Notas de rodapé | Não | |
| Id de títulos | Sim | |
| Listas de definições | Não | |
| Tachado | Sim | |
| Listas de tarefas | Sim | |
| Emoji (copiar e colar) | Desconhecido | |
| Emoji (códigos de acesso) | Desconhecido | |
| Link automático de URL | Sim | |
| Desativar o link automático de URL | Não | |
| HTML | Sim |