GitBook é uma ferramenta de linha de comando baseada em Node.js que suporta formatos de sintaxe Markdown e AsciiDoc, e pode gerar eBooks em HTML, PDF, eBook e outros formatos.
Instale node.js
Antes de usar a ferramenta gitbook, o computador precisa instalar node.js ambiente e, após a instalação, você pode verificar o comando version para testar se a instalação é bem-sucedida:
Instalar o Gitbook
O Gitbook é instalado com npm, linha de comando:
Execute o comando abaixo para ver a versão do GitBook e verificar se a instalação foi bem-sucedida.
Instalar versões históricas
Gitbook-CLI facilita o download e instalação de outras versões do GitBook para testar seus livros:
Usar o gitbook ls-remote enumera as versões que podem ser baixadas.
Editor Markdown
Aqui usamos a sintaxe Markdown como linguagem de escrita para nossos documentos, precisamos preparar um editor Markdown, podemos encontrar muitos editores Markdown no mercado, como Typora, MacDown, Bear, MarkdownPad, MarkdownX, IDE do JetBrains (requer instalação de plugins), Atom, Jianshu, CSDN e o próprio do GitBook GitBook Editor e assim por diante.
Tenho ferramentas de desenvolvimento de VS Code instaladas no meu computador, o VS Code suporta markdown por padrão, só preciso instalar um artefato do plugin de prévia: Markdown Preview Enhanced, e vou usá-lo!
Recomendado por amigos Editor typora, endereço:O login do hiperlink está visível.
Inicialize um livro
O GitBook pode configurar um padrão padrão:
Se você quiser criar um livro em um novo diretório, pode fazê-lo rodando gitbook init ./directory.
Após a execução, você verá mais dois arquivos - README.md e SUMMARY.md, que fazem o seguinte:
README.md - A introdução do livro está escrita neste documento SUMMARY.md - A estrutura do catálogo do livro está configurada aqui
Não conheço a sintaxe do markdown, então escreva apenas algumas frases!
Gerar páginas web estáticas
Gerar páginas web estáticas e rodar servidores
Tudo isso será gerado no catálogo de livros _book.
O comando de servir também pode especificar a porta:
Ao gerar, especifique a versão do gitbook, e ele não será baixado localmente primeiro
Lista todas as versões locais do gitbook
Liste as versões do gitbook que estão disponíveis remotamente
Instale a versão correspondente do gitbook
Atualização para a versão mais recente do gitbook
Desinstale a versão correspondente do gitbook
Especifica o nível de logarítmico
Mensagem de erro de saída
Resumo
O GitBook usa arquivos SUMMARY.md para definir a estrutura dos capítulos e subcapítulos do livro. SUMMARY.md Arquivo é usado para gerar o índice do livro.
O formato do SUMMARY.md é uma lista de links. O título do link servirá como título do capítulo, e o link será direcionado ao caminho para esse arquivo de capítulo.
Adicionar uma lista aninhada ao capítulo pai cria um capítulo filho.
Exemplo simples:
Depois voltamos para a linha de comando e executamos o comando init do gitbook novamente na pasta mybook. O GitBook procura diretórios e arquivos descritos em arquivos SUMMARY.md,Se não, é criado。
Sair arquivos PDF, ePub ou mobi
Se quiser gerar uma versão em PDF, pode rodar o gitbook pdf, da mesma forma, se for exportar em formato epub, gitbook epub, se for formato mobi, gitbook mobi serve.
Se você quiser exportar um e-book em formato PDF, ePub ou mobi,Requer o leitor/gerenciador de eBooks Calibre e ferramentas de linha de comando, caso contrário, um erro pode ser reportado "EbookError: Erro durante a geração do ebook: 'ebook-converter'".
Recursos dos Arquivos Especiais do GitBook:
arquivo | descrição | | book.json | Dados de Configuração (opcionais) | | README.md | Prefácio ou introdução ao eBook (obrigatório) | | SUMMARY.md | Catálogo de e-books (opcional) | | GLOSSARY.md | Lista de vocabulário/termos de anotação (opcional) | Configurações Gerais do Gitbook
O GitBook permite personalizar seu ebook com configurações flexíveis.
Essas opções estão especificadas no arquivo book.json. Para autores que não estão familiarizados com a sintaxe JSON, você pode verificar a sintaxe usando ferramentas como JSONlint.
variável | descrição | | raiz | O caminho para a pasta raiz que contém todos os arquivos de livros, exceto book.json | | Estrutura | Especifique caminhos para readme, resumos, glossários, etc | | Título | O título do seu livro, o valor padrão, é extraído do README. Em GitBook.com, esse campo já está preenchido. | | descrip{filter}tion | A descrição do seu livro, o valor padrão, é extraída do README. Em GitBook.com, esse campo já está preenchido. | | autor | Nome do autor. Em GitBook.com, esse campo já está preenchido. | | ISBN | ISBN | | Idioma | O tipo de idioma deste livro é o código ISO. O valor padrão é en | | Direção | Ordem de leitura do texto. Pode ser RTL (da direita para a esquerda) ou LTR (da esquerda para a direita), e o valor padrão depende do valor da linguagem. | | gitbook | A versão do GitBook deve ser usada. Use a especificação SemVer e aceite condições semelhantes a "> = 3.0.0". |
|