From 29ed0857046640a08b3ac406609c962fecd6ae32 Mon Sep 17 00:00:00 2001 From: Silvio Rhatto Date: Thu, 6 Jun 2024 16:11:29 -0300 Subject: Updates documentation --- content/published/00-intro/intro.md | 20 ++++++++++++++------ content/published/05-structure/structure.md | 21 --------------------- content/published/05-workflow/funcionamento.md | 9 +++++++++ content/published/10-installation/installation.md | 16 ---------------- content/published/10-structure/structure.md | 21 +++++++++++++++++++++ content/published/15-installation/installation.md | 22 ++++++++++++++++++++++ 6 files changed, 66 insertions(+), 43 deletions(-) delete mode 100644 content/published/05-structure/structure.md create mode 100644 content/published/05-workflow/funcionamento.md delete mode 100644 content/published/10-installation/installation.md create mode 100644 content/published/10-structure/structure.md create mode 100644 content/published/15-installation/installation.md diff --git a/content/published/00-intro/intro.md b/content/published/00-intro/intro.md index 06e6fb4..5e5c7d0 100644 --- a/content/published/00-intro/intro.md +++ b/content/published/00-intro/intro.md @@ -1,11 +1,19 @@ # Introdução {#intro} -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^[@TODO: definir o método arbóreo-espiral.]. +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 no futuro +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/published/05-structure/structure.md b/content/published/05-structure/structure.md deleted file mode 100644 index edc1884..0000000 --- a/content/published/05-structure/structure.md +++ /dev/null @@ -1,21 +0,0 @@ -# Estrutura de pastas {#estrutura} - -A estrutura de pastas de um projeto usando Bookup: - -* `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. - * `published`: aqui vai todo o material a ser compilado em livro. -* `notes`: caderno de anotações. -* `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. -* `public`: 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/published/05-workflow/funcionamento.md b/content/published/05-workflow/funcionamento.md new file mode 100644 index 0000000..66ff216 --- /dev/null +++ b/content/published/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/published/10-installation/installation.md b/content/published/10-installation/installation.md deleted file mode 100644 index b2e2392..0000000 --- a/content/published/10-installation/installation.md +++ /dev/null @@ -1,16 +0,0 @@ -# Instalação {#instalacao} - -Procedimento de instalação: - -* Vendorização (repositórios `bookup` e de bibliografia). -* Symlinking: - * `_bookdown.yml`. - * `output.yml`. -* Arquivos requeridos: - * `.gitignore`. - * `images/cover.png`. - * `_bookup.yml`. - * `_biblio.yml`. - * `LICENSE`. - * `DISCLAIMER`. - * `snippets/{contact,cover,keywords,project,url,volume}.txt`. diff --git a/content/published/10-structure/structure.md b/content/published/10-structure/structure.md new file mode 100644 index 0000000..f413396 --- /dev/null +++ b/content/published/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. + * `published`: aqui vai todo o material a ser compilado em livro. +* `notes`: caderno de anotações. +* `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. +* `public`: 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/published/15-installation/installation.md b/content/published/15-installation/installation.md new file mode 100644 index 0000000..9024b41 --- /dev/null +++ b/content/published/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`. -- cgit v1.2.3