aboutsummaryrefslogtreecommitdiff
path: root/content/sections
diff options
context:
space:
mode:
authorSilvio Rhatto <rhatto@riseup.net>2024-06-08 10:05:30 +0100
committerSilvio Rhatto <rhatto@riseup.net>2024-06-08 10:05:30 +0100
commit46087a2503032443d7f0613e5aeb2a5195c27850 (patch)
tree910ebd4bdc62360ed53881671a471d5ef2e2ca44 /content/sections
parentbff0778cb9751a0581ab0eb2ca97cbdca8bcca03 (diff)
downloadbookup-46087a2503032443d7f0613e5aeb2a5195c27850.tar.gz
bookup-46087a2503032443d7f0613e5aeb2a5195c27850.tar.bz2
Fix: misc improvements
Diffstat (limited to 'content/sections')
-rw-r--r--content/sections/00-intro/intro.md19
-rw-r--r--content/sections/05-workflow/funcionamento.md9
-rw-r--r--content/sections/10-structure/structure.md21
-rw-r--r--content/sections/15-installation/installation.md22
4 files changed, 71 insertions, 0 deletions
diff --git a/content/sections/00-intro/intro.md b/content/sections/00-intro/intro.md
new file mode 100644
index 0000000..5e5c7d0
--- /dev/null
+++ b/content/sections/00-intro/intro.md
@@ -0,0 +1,19 @@
+# Introdução {#intro}
+
+Bookup é um conjunto de templates, programas e fluxos de trabalho para a
+autoria de livros em formatos HTML, PDF e EPUB.
+
+Ele é um componente de software modular baseado em [Bookdown][].
+
+Foi criado para resolver o problema de editar muitos livros simultaneamente:
+Bookup ajuda a manter um esquema uniforme, ao invés de ter que implementar e
+corrigir funcionalidades paralelamente em muitos repositórios.
+
+Com ele, a produção de conteúdo fica parecida com o trabalho com outros
+códigos.
+
+Não foi priorizado investir tempo em generalizar tudo ao máximo. O mais
+importante foi criar uma base comum para os meus livros, e talvez aos poucos
+generalizar para que possa ser usado por outras iniciativas.
+
+[Bookdown]: https://bookdown.org
diff --git a/content/sections/05-workflow/funcionamento.md b/content/sections/05-workflow/funcionamento.md
new file mode 100644
index 0000000..66ff216
--- /dev/null
+++ b/content/sections/05-workflow/funcionamento.md
@@ -0,0 +1,9 @@
+# Funcionamento {#funcionamento}
+
+Bookup opera através da _compilação_ de arquivos:
+
+```
+ /--> Livro PDF
+Arquivos fonte em Markdown --> Compilação -->
+ \--> Livro HTML
+```
diff --git a/content/sections/10-structure/structure.md b/content/sections/10-structure/structure.md
new file mode 100644
index 0000000..98b2f91
--- /dev/null
+++ b/content/sections/10-structure/structure.md
@@ -0,0 +1,21 @@
+# Estrutura de pastas {#estrutura}
+
+A estrutura de pastas de um projeto usando Bookup é a seguinte:
+
+* `archive`: armazena versões antigas do livro.
+* `content`: o conteúdo do livro.
+ * `drafts`: deixe aqui os textos que ainda estão em composição.
+ * `sections`: aqui vai todo o material a ser compilado em livro.
+ * `notes`: caderno de anotações a ser incluído no material público.
+* `slides`: slides no formato Markdown.
+* `site`: HTML opcional usado para o sítio base; se existir, o livro será
+ colocado dentro da pasta `public/book` ou algo assim.
+* `build`: o livro compilado (HTML, PDF e outros formatos):
+ * `notes`: caderno de notas compilado.
+ * `book`: o livro compilado, se houver uma pasta `site`, caso contrário o
+ conteúdo dolivro será colocado na pasta raíz do diretório `public`.
+* `biblio`: bibliografia.
+* `images`: pasta de imagens.
+* `vendor/bookup`:
+ * `content`: documentação do Bookup.
+ * `vendor/{Fuse.js,}`: dependências.
diff --git a/content/sections/15-installation/installation.md b/content/sections/15-installation/installation.md
new file mode 100644
index 0000000..9024b41
--- /dev/null
+++ b/content/sections/15-installation/installation.md
@@ -0,0 +1,22 @@
+# Instalação {#instalacao}
+
+Procedimento de instalação do Bookup.
+
+## Vendorização
+
+* Vendorização (repositórios `bookup` e de bibliografia).
+
+## Links simbólicos
+
+* `_bookdown.yml`.
+* `output.yml`.
+
+## Arquivos requeridos
+
+* `.gitignore`.
+* `images/cover.png`.
+* `_bookup.yml`.
+* `_biblio.yml`.
+* `LICENSE`.
+* `DISCLAIMER`.
+* `snippets/{contact,cover,keywords,project,url,volume}.txt`.