blob: f6613d32bd81384c7addb57239538a5b5f4b5e8b (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
|
# Bookup {#bookup}
Criar Bookup ajudou a manter um esquema uniforme, ao invés de ter que
implementar e corrigir funcionalidades paralelamente em muitos repositórios, já
que os livros tendem a aumentar. Lidando com a produção de conteúdo como
lidamos com outros códigos, mas sem algoritmizar, ao contrário: usando um
processo arbóreo-espiral.
# Folder structure {#structure}
Book folder structure:
* `archive`: to hold archives (older book versions).
* `content`: book content:
* `drafts`: leave here texts still being redacted.
* `published`: here goes all the material to be compiled.
* `notes`: notebook.
* `slides`: slides in Markdown format.
* `site`: optional HTML used for the base site; if this exists, the book will
be placed under `public/book` or something like that.
* `public`: compiled book (HTML, PDF and other formats):
* `notes`: compiled notebook.
* `book`: compiled book if there's a `site` folder, otherwise book contents
will be placed in the root of the public folder.
* `biblio`: bibliography.
* `images`: images folder.
* `vendor/bookup`:
* `content`: Bookup documentation.
* `vendor/{Fuse.js,}`: dependencies.
# Instalation {#installation}
Setup procedure:
* Vendorizantion (`bookup` and bibliography repositories).
* Symlinking.
* Basic files:
* `images/cover.png`.
* `_bookup.yml`.
* `_biblio.yml`.
* `LICENSE`.
* `DISCLAIMER`.
* `snippets/`.
|
