diff options
Diffstat (limited to 'content/sections')
| -rw-r--r-- | content/sections/00-intro/intro.md | 11 | ||||
| -rw-r--r-- | content/sections/02-features/features.md | 3 | ||||
| -rw-r--r-- | content/sections/10-structure/structure.md | 2 | ||||
| -rw-r--r-- | content/sections/15-installation/installation.md | 2 |
4 files changed, 15 insertions, 3 deletions
diff --git a/content/sections/00-intro/intro.md b/content/sections/00-intro/intro.md index 169069a..cdc873b 100644 --- a/content/sections/00-intro/intro.md +++ b/content/sections/00-intro/intro.md @@ -1,7 +1,9 @@ # Introduction {#intro} -Bookup^[@bookup] is a set of templates, scripts and workflows for book -authoring in HTML, PDF and other formats. + +Bookup^[@bookup] is a framework for _living books_, composed by a set of +templates, scripts and workflows for book authoring in HTML, PDF and other +formats. It's a modular software component based on [Bookdown][]. @@ -9,6 +11,11 @@ It was created to solve the problem of editing many books simultaneously: Bookup helps to keep an uniform scheme instead of having to implement and fix funcionalities across many repositories in parallel. +Bookup also allows for making these books publicly available as +work-in-progress material ("living books"), as it fully integrates with Git +tags for versioning, a change log to register major changes and RSS/ATOM feeds, +so others can track down new book revisions. + [Bookup][] makes book production similar to working with other codebases. But [Bookup][] is very opinionated. diff --git a/content/sections/02-features/features.md b/content/sections/02-features/features.md index 606ed1f..2f5aa08 100644 --- a/content/sections/02-features/features.md +++ b/content/sections/02-features/features.md @@ -17,6 +17,9 @@ Main Bookup features: * Adds the compilation metadata: * Version based on Git tag or commit. + * Compilation date. * Localization support: templates can be easily translated to other languages. + +* RSS, Atom and Markdown changelogs. diff --git a/content/sections/10-structure/structure.md b/content/sections/10-structure/structure.md index 263a764..b3432ff 100644 --- a/content/sections/10-structure/structure.md +++ b/content/sections/10-structure/structure.md @@ -21,3 +21,5 @@ A Bookup project folder structure looks like this: * `vendor/bookup`: where the Bookup codebase actually resides: * `content`: Bookup documentation. * `vendor/{Fuse.js,}`: dependencies. +* `_changelog.yml`: to track changes in your book, used to build RSS and Atom + feeds, as well as a ChangeLog in Markdown format. diff --git a/content/sections/15-installation/installation.md b/content/sections/15-installation/installation.md index d2133d2..8cfb941 100644 --- a/content/sections/15-installation/installation.md +++ b/content/sections/15-installation/installation.md @@ -22,7 +22,7 @@ Bookup installation procedure. * `LICENSE`. * `DISCLAIMER`. * `images/cover.png`. -* `snippets/{contact,cover,keywords,project,url,volume}.txt`. +* `snippets/{contact,cover,keywords,project,url,volume,publisher,publisher-url}.txt`. * `snippets/changes.md`. ## Optional files |