menu

GitBook

O GitBook é uma solução hospedada para sites de documentação e bases de conhecimento.

Visão geral

Em poucas palavras, você entra no site do GitBook e usa o editor baseado na Web para escrever sua documentação. Ou, se preferir manter o controle sobre o seu conteúdo, você pode mantê-lo em um repositório do GitHub integrado ao GitBook. De qualquer forma, você pode criar diferentes páginas da Web e organizá-las em uma ordem lógica. Quando tudo estiver da maneira que você desejar, basta publicá-la em um domínio personalizado.

Como muitos projetos, o GitBook começou como uma cadeia de ferramentas de código aberto com uma oferta comercial, mas acabou descartando o projeto de código aberto em favor de uma nova oferta proprietária e de código fechado, hospedada exclusivamente em seu site. A cadeia de ferramentas de código aberto ainda está disponível, mas como essa opção agora não é suportada, este artigo documenta apenas a nova opção hospedada.

A vantagem do GitBook sobre uma ferramenta como o Docusaurus é que o GitBook cuida da construção e hospedagem do site, e os controles WYSIWYG são intuitivos o suficiente para serem usados ​​pelos novatos do Markdown. No site do GitBook, o editor em tempo real oculta a sintaxe de formatação do Markdown após a digitação. O editor é um pouco esquisito, mas o site geralmente funciona tanto para especialistas em Markdown quanto para pessoas que não têm experiência com o a linguagem. Você também pode simplesmente copiar e colar texto no formato Markdown na interface do GitBook.

Site: https://www.gitbook.com/

Suporte do Markdown no GitBook

O GitBook fornece suporte para os seguintes elementos Markdown.

Elemento Suporte Obs
Títulos Sim
Parágrafos Sim
Quebras de linha Sim
Negrito Sim
Itálico Sim
Bloco de citação 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 O realce da sintaxe também é suportado.
Notas de rodapé Não
Id de títulos Sim
Listas de definições Não
Riscado 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

Veja também

Documentação do Markdown no GitBook