O GitBook é uma plataforma que permite que você e sua equipe criem e colaborem em sites de documentação. O GitBook faz isso usando conceitos de controle de versão, como ramificação e mesclagem.
Como muitos membros da equipe podem trabalhar em um único site de documentação, o GitBook permite que você crie e gerencie rascunhos separados. Você também pode visualizar as diferenças entre o rascunho atual e a cópia da documentação mestre.
Vários tipos de blocos estão disponíveis para você adicionar às suas páginas wiki. Isso inclui títulos, parágrafos, imagens, dicas, tabelas, blocos de código, anexos de arquivos e muito mais.
Como adicionar blocos de conteúdo no GitBook
Você pode visualizar uma lista dos blocos de conteúdo disponíveis para adicionar a uma página. Você pode fazer isso clicando em qualquer lugar na página e clicando no botão mais símbolo que aparece. Você também pode pesquisar diretamente um bloco de conteúdo específico.
Você pode adicionar conteúdo usando Markdown. Se você não usou Markdown antes, você pode aprender mais sobre
como começar com Markdown. Você também pode ler mais sobre por que o Markdown é tão popular.Como adicionar parágrafos, listas, citações ou blocos de código
Para adicionar listas, parágrafos, citações, blocos de código ou outros blocos de conteúdo simples, abra a lista suspensa e selecione entre os tipos disponíveis.
- Em uma página em seu site de documentação, clique no botão mais botão no local onde você gostaria de adicionar seu conteúdo.
- Na lista suspensa, você pode rolar pela lista para visualizar as diferentes opções de conteúdo.
- A partir daqui, selecione qualquer tipo de conteúdo simples, como um parágrafo, bloco de código, título ou citação. O GitBook alterará automaticamente o conteúdo para corresponder ao formato que você selecionou.
Como adicionar imagens ou anexos de arquivo
Para adicionar imagens, use o menu suspenso para selecionar o Imagens opção de bloco de conteúdo. Para adicionar arquivos, selecione o Inserir arquivos opção em vez disso. Você pode então usar o painel do lado direito para gerenciar suas imagens e arquivos carregados.
- Abra uma página em seu site de documentação. Clique no mais botão para abrir a lista suspensa de blocos de conteúdo disponíveis.
- Selecionar Inserir imagens.
- No painel direito que aparece, existem três guias. o arquivos guia permite que você carregue seu próprio arquivo de imagem. o URL guia permite vincular a uma imagem online. Você também pode abrir o Abrir aba. É aqui que você pode selecionar fotos existentes que não exigem atribuição.
- Depois de adicionar uma imagem, clique no botão três pontos botão localizado no canto superior esquerdo da imagem. Isso abrirá uma lista suspensa onde você poderá alinhar a imagem ou excluí-la. Você também pode dar uma legenda à imagem.
- Para inserir arquivos, coloque o cursor em qualquer lugar em uma página do site de documentação. Clique no mais botão para abrir a lista suspensa de tipos de bloco de conteúdo. Desta vez, clique no botão inserir arquivos opção.
- Um painel direito semelhante aparecerá, permitindo que você carregue qualquer anexo de arquivo em vez de uma imagem. Clique em Procurar arquivos para selecionar um arquivo armazenado localmente em seu computador.
- O arquivo aparecerá na lista. Clique no arquivo e o GitBook criará um bloco de conteúdo com o anexo do arquivo na página que você abriu. Clicar neste bloco de conteúdo fará o download do anexo do arquivo.
Como adicionar dicas
Você também pode adicionar dicas à sua página. Você pode alterar o ícone das dicas para usar vermelho para perigo, laranja para aviso, azul para informações ou verde para sucesso.
- Para adicionar uma dica, clique no botão mais botão para abrir a lista suspensa de blocos de conteúdo disponíveis.
- Selecionar Dica.
- Isso adicionará uma dica à sua página. Por padrão, o tipo de dica é "informações" e contém um ícone azul.
- Você pode alterar o tipo de dica clicando no ícone. Isso percorrerá os quatro tipos de dicas diferentes.
Como adicionar tabelas
Você pode adicionar tabelas selecionando o tabela opção da lista suspensa. Depois de ter a tabela na página, você pode adicionar novas linhas ou colunas. Você também pode modificar os nomes e tipos de dados das colunas e alterar os dados dentro da tabela.
- Clique no mais botão para abrir a lista suspensa de blocos de conteúdo disponíveis.
- Selecionar Mesa.
- Clique no cabeçalho de uma coluna na tabela. Isso abrirá um novo menu menor, onde você pode alterar o nome da coluna selecionada. Este menu também permite excluir ou ocultar a coluna selecionada. Para determinados tipos de dados de coluna, você também pode alinhar o conteúdo dentro da coluna.
- Por padrão, o tipo de dados selecionado para as colunas é "Texto". Clique no botão com a T símbolo para alterar o tipo de dados. Você pode alterá-lo para um número, caixa de seleção, lista suspensa, anexo de arquivo, classificação ou mais.
- Clique no ícone de seis pontos perto do canto superior esquerdo da mesa. Aqui você pode inserir novas colunas e linhas ou excluir a tabela inteira. Você também pode ocultar ou mostrar determinadas colunas ou alterar outras propriedades da tabela.
Como adicionar blocos de link de página
Os blocos de link de página são links que ocupam toda a linha da página. Ao adicionar o link, você deve vincular à página que será aberta quando alguém clicar nela.
- Clique no mais botão para abrir a lista suspensa de blocos de conteúdo disponíveis.
- Clique em link da página.
- Na nova lista suspensa, escolha a página à qual você está vinculando.
- O link da sua página aparecerá dentro de um bloco na página.
Usando o GitBook para Documentação
O GitBook é uma ferramenta de documentação que usa conceitos de controle de versão, como ramificação e mesclagem. Isso permite que mais de um membro da equipe trabalhe simultaneamente na documentação. Também ajuda a gerenciar quaisquer conflitos que ocorram.
Você pode adicionar todos os tipos de blocos de conteúdo a uma página. Você pode usar títulos, parágrafos, blocos de código ou marcadores para reformatar seu conteúdo. Você pode alterar o tipo de dica, a mensagem e o tipo de ícone das dicas, bem como personalizar as colunas de uma tabela.
A guia Arquivos permite gerenciar imagens e anexos de arquivos que você carrega no site. Links de página permitem que você crie links grandes que os usuários podem identificar facilmente.
Se estiver criando documentação relacionada à linguagem Go, você pode usar Godoc. Godoc permite que você documente automaticamente seu código Go.
