Skip to content

Home

Jump to bottom
Gustavo Barbosa edited this page Dec 30, 2015 · 4 revisions

Como utilizar o GitBook?

Para a publicação desse livro, estamos utilizando o GitBook.

O GitBook pode ser instalado utilizando o NPM, execute:

$ npm install gitbook-cli -g

Para criar um arquivo SUMMARY.md com a estrutura básica para o livro, execute:

$ gitbook init

Você pode iniciar um server local do GitBook (disponível num http://localhost:4000/ ou algo similar), execute:

$ gitbook serve

Ele vai gerar um servidor local para os seus testes. Caso você queira gerar uma build de um site estático para leitura online do livro, execute:

$ gitbook build

Preview Gitbook

Estrutura

Capítulos e sub-capítulos

GitBook usa um arquivo SUMMARY.md para definir a estrutura de capítulos e subcapítulos do livro.

O arquivo SUMMARY.md é usado para gerar a tabela do livro de conteúdos.

O formato do SUMMARY.md é simplesmente uma lista de links, onde o nome do link é usado como o nome do capítulo, e o alvo é um caminho para o arquivo desse capítulo.

Exemplos:

# Summary

* [Chapter 1](chapter1.md)
* [Chapter 2](chapter2.md)
* [Chapter 3](chapter3.md)

Exemplos com sub-capítulos

# Summary

* [Part I](part1/README.md)
    * [Writing is nice](part1/writing.md)
    * [GitBook is nice](part1/gitbook.md)
* [Part II](part2/README.md)
    * [We love feedback](part2/feedback_please.md)
    * [Better tools for authors](part2/better_tools.md)

Markdown

GitBook usa a sintaxe Markdown por padrão.

Clone this wiki locally