From b6d9069b98df5947409d6cc2c4181b57fe23b0d3 Mon Sep 17 00:00:00 2001 From: Silvio Rhatto Date: Thu, 6 Jun 2024 09:09:16 -0300 Subject: Reorganize content; minor fixes --- content/published/00-intro/intro.md | 38 +---------------------- content/published/05-structure/structure.md | 21 +++++++++++++ content/published/10-installation/installation.md | 14 +++++++++ 3 files changed, 36 insertions(+), 37 deletions(-) create mode 100644 content/published/05-structure/structure.md create mode 100644 content/published/10-installation/installation.md (limited to 'content') diff --git a/content/published/00-intro/intro.md b/content/published/00-intro/intro.md index f6613d3..80ede4e 100644 --- a/content/published/00-intro/intro.md +++ b/content/published/00-intro/intro.md @@ -4,40 +4,4 @@ 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/`. +processo arbóreo-espiral^[@TODO: definir o método arbóreo-espiral.]. diff --git a/content/published/05-structure/structure.md b/content/published/05-structure/structure.md new file mode 100644 index 0000000..d43703f --- /dev/null +++ b/content/published/05-structure/structure.md @@ -0,0 +1,21 @@ +# 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. diff --git a/content/published/10-installation/installation.md b/content/published/10-installation/installation.md new file mode 100644 index 0000000..a4230e3 --- /dev/null +++ b/content/published/10-installation/installation.md @@ -0,0 +1,14 @@ +# Instalation {#installation} + +Setup procedure: + +* Vendorizantion (`bookup` and bibliography repositories). +* Symlinking. +* Basic files: + * `.gitignore`. + * `images/cover.png`. + * `_bookup.yml`. + * `_biblio.yml`. + * `LICENSE`. + * `DISCLAIMER`. + * `snippets/`. -- cgit v1.2.3