aboutsummaryrefslogtreecommitdiff
path: root/content/published/00-intro/intro.md
diff options
context:
space:
mode:
Diffstat (limited to 'content/published/00-intro/intro.md')
-rw-r--r--content/published/00-intro/intro.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/content/published/00-intro/intro.md b/content/published/00-intro/intro.md
index 306ce81..f6613d3 100644
--- a/content/published/00-intro/intro.md
+++ b/content/published/00-intro/intro.md
@@ -5,3 +5,39 @@ 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/`.