aboutsummaryrefslogtreecommitdiff
path: root/content/published/05-structure
diff options
context:
space:
mode:
Diffstat (limited to 'content/published/05-structure')
-rw-r--r--content/published/05-structure/structure.md21
1 files changed, 21 insertions, 0 deletions
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.