diff options
| -rw-r--r-- | TODO.md | 43 | ||||
| -rw-r--r-- | _output.yml | 6 | ||||
| l--------- | bookup | 1 | ||||
| -rw-r--r-- | content/published/00-intro/intro.md | 36 | ||||
| -rw-r--r-- | kvmxfile | 6 | ||||
| l--------- | vendor/bookup | 1 |
6 files changed, 57 insertions, 36 deletions
@@ -1,43 +1,24 @@ # TODO -* [ ] Empacotar solução de publicação baseada em Bookdown num projeto de nome - `bookup` ("a bookdown-based publishing solution" ou similar, para - facilmente realizar a editoração e autoria de livros. +## Basic + +* [ ] Package a Bookdown-based publishing solution in a project named `bookup` + ("a bookdown-based publishing solution") + or similar, to ease book editing and authorship. * [ ] Usar como base o código do repositório `ensaios`, com eventuais adendos do repositório `cybersni`. Inicialmente, não é necessário investir tempo em generalizar tudo ao máximo. O importante é criar uma base comum para os meus livros, e talvez no futuro generalizar para que possa ser usado por outras iniciativas. -* [ ] Setup procedure: - * [ ] Vendorizantion (`bookup` and bibliography repositories). - * [ ] Symlinking. - * [ ] Basic files: - * `images/cover.png`. - * `_bookup.yml`. - * `_biblio.yml`. - * `LICENSE`. - * `DISCLAIMER`. - * `snippets/`. +* [ ] Create a basic documentation. +* [ ] Notebook support. +* [ ] Website support. + +## Bonus + +* [ ] GitLab CI. * [ ] Localization support? * It makes sense to localize common strings in the book structure. * But maybe it does not make much sense to localize strings in PO files for the content itself, since long text translations may need an engine that is not line based. Needs more thinking. -* [ ] 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`: used when no content is available (Bookup documentation). - * `vendor/{Fuse.js,}`: dependencies. diff --git a/_output.yml b/_output.yml index 0346264..f08e81e 100644 --- a/_output.yml +++ b/_output.yml @@ -64,9 +64,9 @@ bookdown::tufte_book2: template: templates/tufte-handout.tex includes: - in_header: structure/00-header.tex - before_body: structure/00-preamble.tex - after_body: structure/99-end.tex + in_header: vendor/bookup/structure/00-header.tex + before_body: vendor/bookup/structure/00-preamble.tex + after_body: vendor/bookup/structure/99-end.tex toc: true toc_depth: 3 #toc_appendix: true @@ -0,0 +1 @@ +bookup
\ No newline at end of file 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/`. @@ -68,8 +68,10 @@ shared_folder_mountpoint="/srv/shared" #provision_command="/usr/local/share/kvmx/provision/debian/trashman" #provision_command="/usr/local/share/kvmx/provision/debian/desktop-basic" provision_command="/usr/local/share/kvmx/provision/debian/development" -provision_command="$provision_command && /srv/shared/bin/provision && /srv/shared/bin/provision-dict" -provision_command="$provision_command && /srv/shared/bin/provision-host && /srv/shared/bin/provision-docker" +provision_command="$provision_command && /srv/shared/bin/provision" +provision_command="$provision_command && /srv/shared/bin/provision-host" +#provision_command="$provision_command && /srv/shared/bin/provision-dict" +#provision_command="$provision_command && /srv/shared/bin/provision-docker" # Startup command #startup_command="/path/to/custom/command" diff --git a/vendor/bookup b/vendor/bookup new file mode 120000 index 0000000..a96aa0e --- /dev/null +++ b/vendor/bookup @@ -0,0 +1 @@ +..
\ No newline at end of file |