crowbook/guide.book

# Metadata
author: "Élisabeth Henry"
title: Crowbook User Guide
description: >-
  Crowbook allows to render a book written in Markdown in various
  formats. This is some kind of manual for it, and a way to
  demonstrate and test it.
lang: en
cover: cover.png
version: 0.15.0
date: 2019-12-15
license: >-
  This guide is published under the Creative Commons Attribution-ShareAlike 4.0-International license.

# Options for generating files
output:
  - epub
  - pdf
  - html
  - odt
output.epub: book.epub
output.html: book.html
output.html.dir: html
output.pdf: book.pdf
output.odt: book.odt

output.base_path: docs/book/
output.proofread.html: book.proof.html
output.proofread.html.dir: html_proof
output.proofread.pdf: book.proof.pdf

# Resources options
resources.base_path.images: img/  # where to find the cover

crowbook.markdown.superscript: true

proofread.repetitions: true
proofread.languagetool: true

# Rendering options
rendering.num_depth: 4
rendering.initials: false
rendering.inline_toc: true
rendering.chapter.template: "{{{number}}}. {{{chapter_title}}}"
rendering.chapter.roman_numerals: false
rendering.part.reset_counter: true
rendering.highlight: syntect

html.highlight.theme: "Solarized (dark)"

# Html options
html.icon: crowbook.svg
html.header: "{{{title}}} {{{version}}}"
html.footer: "Generated by [Crowbook](https://github.com/lise-henry/crowbook) {{{crowbook_version}}}"
html.side_notes: false
html.standalone.one_chapter: false

# Custom colors
html.css.colours: guide/colors.css
html.highlight.css: guide/tomorrow-night.css

# Latex options
tex.class: book
tex.links_as_footnotes: false
tex.paper.size: a4paper

# Epub options
epub.version: 3

# Finally, our files.
# Paths are relative to the directory where this file is
+ README.md
+ guide/01_arguments.md
+ guide/02_config.md
+ guide/03_markdown.md
+ guide/04_templates.md
+ guide/05_proofreading.md
+ guide/06_interactive_fiction.md
+ guide/07_miscellaneous.md
+ guide/08_contributing.md
- ChangeLog.md
- LICENSE.md
cleaned config.book 2016-02-23 22:50:37 +01:00			`# Metadata`
Add templates.md as a new book chapter 2016-09-22 06:59:22 +02:00			`author: "Élisabeth Henry"`
Add crowbook logo 2016-09-16 21:36:48 +02:00			`title: Crowbook User Guide`
Update documentation 2016-03-01 21:41:23 +01:00			`description: >-`
chore: update docs 2020-01-08 18:13:24 +01:00			`Crowbook allows to render a book written in Markdown in various`
			`formats. This is some kind of manual for it, and a way to`
			`demonstrate and test it.`
Update templates.md 2016-09-22 20:45:32 +02:00			`lang: en`
Clean up config.book, but try to use a few options 2016-09-23 02:36:53 +02:00			`cover: cover.png`
Improve docs for maintainability, update highlightjs and replace colours with colors Merge patch from jrappen, see https://github.com/lise-henry/crowbook/pull/64 + mark "html.css.colours" as deprecated (but still a working alias) 2019-12-15 23:42:00 +01:00			`version: 0.15.0`
			`date: 2019-12-15`
Update guide.book version 2017-06-03 04:53:50 +02:00			`license: >-`
			`This guide is published under the Creative Commons Attribution-ShareAlike 4.0-International license.`
Add templates.md as a new book chapter 2016-09-22 06:59:22 +02:00
Clean up config.book, but try to use a few options 2016-09-23 02:36:53 +02:00			`# Options for generating files`
Update guide.book to version 0.13.0 2017-07-14 19:40:13 +02:00			`output:`
			`- epub`
			`- pdf`
			`- html`
			`- odt`
Clean up config.book, but try to use a few options 2016-09-23 02:36:53 +02:00			`output.epub: book.epub`
			`output.html: book.html`
Update guide 2016-12-31 00:00:31 +01:00			`output.html.dir: html`
Clean up config.book, but try to use a few options 2016-09-23 02:36:53 +02:00			`output.pdf: book.pdf`
			`output.odt: book.odt`
chore: update docs 2020-01-08 18:13:24 +01:00
Update config.book 2016-09-23 03:34:31 +02:00			`output.base_path: docs/book/`
Remove println 2016-09-27 03:35:11 +02:00			`output.proofread.html: book.proof.html`
Update guide 2016-12-31 00:00:31 +01:00			`output.proofread.html.dir: html_proof`
Add proofread.languagetool and proofread.languagetool.port options 2016-09-28 01:28:32 +02:00			`output.proofread.pdf: book.proof.pdf`
added a book_example 2016-02-19 21:35:49 +01:00
Clean up config.book, but try to use a few options 2016-09-23 02:36:53 +02:00			`# Resources options`
			`resources.base_path.images: img/ # where to find the cover`
Add crowbook link to user guide book 2016-09-18 01:39:50 +02:00
Update guide 2017-06-05 17:53:34 +02:00			`crowbook.markdown.superscript: true`

Update guide.book file 2017-03-05 03:39:03 +01:00			`proofread.repetitions: true`
Add proofread.languagetool and proofread.languagetool.port options 2016-09-28 01:28:32 +02:00			`proofread.languagetool: true`
Remove println 2016-09-27 03:35:11 +02:00
Clean up config.book, but try to use a few options 2016-09-23 02:36:53 +02:00			`# Rendering options`
chore: update docs 2020-01-08 18:13:24 +01:00			`rendering.num_depth: 4`
Remove println 2016-09-27 03:35:11 +02:00			`rendering.initials: false`
chore: update docs 2020-01-08 18:13:24 +01:00			`rendering.inline_toc: true`
Fix chapter template in guide.book 2017-03-26 20:29:56 +02:00			`rendering.chapter.template: "{{{number}}}. {{{chapter_title}}}"`
Rename some options * rendering.chapter_template -> rendering.chapter.template * rendering.part_template -> rendering.part.template * rendering.roman_numerals.chapters -> rendering.chapter.roman_numerals * rendering.roman_numerals.parts -> rendering.part.roman_numerals 2016-12-22 17:43:09 +01:00			`rendering.chapter.roman_numerals: false`
Update guide 2016-12-31 00:00:31 +01:00			`rendering.part.reset_counter: true`
Update guide.book file 2017-03-05 03:39:03 +01:00			`rendering.highlight: syntect`

			`html.highlight.theme: "Solarized (dark)"`
Remove docs/ directory as I don't want to publish it to crates.io 2016-09-22 15:35:38 +02:00
Clean up config.book, but try to use a few options 2016-09-23 02:36:53 +02:00			`# Html options`
Add html.icon to guide.book 2016-12-16 02:37:56 +01:00			`html.icon: crowbook.svg`
Updated config.book 2016-10-06 23:10:11 +02:00			`html.header: "{{{title}}} {{{version}}}"`
Clean up config.book, but try to use a few options 2016-09-23 02:36:53 +02:00			`html.footer: "Generated by [Crowbook](https://github.com/lise-henry/crowbook) {{{crowbook_version}}}"`
Update guide 2016-12-31 00:00:31 +01:00			`html.side_notes: false`
			`html.standalone.one_chapter: false`
Set use_initials to true 2016-09-14 01:28:29 +02:00
Improve docs for maintainability, update highlightjs and replace colours with colors Merge patch from jrappen, see https://github.com/lise-henry/crowbook/pull/64 + mark "html.css.colours" as deprecated (but still a working alias) 2019-12-15 23:42:00 +01:00			`# Custom colors`
			`html.css.colours: guide/colors.css`
updated guide and its theme 2016-10-07 00:24:24 +02:00			`html.highlight.css: guide/tomorrow-night.css`
Add html.css.colours template This is done so it is possible to only override the colour scheme, while not having to generate a whole new CSS file. Also, instead of e.g. {{fr}} being set to true if lang is "fr", it's now {{lang_fr}}. 2016-10-06 19:36:34 +02:00
fixed some escaping, now allow use output.xx instead of output_xxx in book file 2016-02-21 05:29:40 +01:00			`# Latex options`
Update templates.md 2016-09-22 20:45:32 +02:00			`tex.class: book`
fixed some escaping, now allow use output.xx instead of output_xxx in book file 2016-02-21 05:29:40 +01:00			`tex.links_as_footnotes: false`
Update guide.book to version 0.13.0 2017-07-14 19:40:13 +02:00			`tex.paper.size: a4paper`
added a book_example 2016-02-19 21:35:49 +01:00
Clean up config.book, but try to use a few options 2016-09-23 02:36:53 +02:00			`# Epub options`
fixed some escaping, now allow use output.xx instead of output_xxx in book file 2016-02-21 05:29:40 +01:00			`epub.version: 3`
now supports epub3 (in theory) 2016-02-20 03:41:29 +01:00
cleaned config.book 2016-02-23 22:50:37 +01:00			`# Finally, our files.`
			`# Paths are relative to the directory where this file is`
moved config.book to root dir 2016-02-26 23:16:32 +01:00			`+ README.md`
chore: update docs 2020-01-08 18:13:24 +01:00			`+ guide/01_arguments.md`
			`+ guide/02_config.md`
			`+ guide/03_markdown.md`
			`+ guide/04_templates.md`
			`+ guide/05_proofreading.md`
			`+ guide/06_interactive_fiction.md`
			`+ guide/07_miscellaneous.md`
			`+ guide/08_contributing.md`
added license and bugs to config.book 2016-02-26 23:37:55 +01:00			`- ChangeLog.md`
Add html.css.colours template This is done so it is possible to only override the colour scheme, while not having to generate a whole new CSS file. Also, instead of e.g. {{fr}} being set to true if lang is "fr", it's now {{lang_fr}}. 2016-10-06 19:36:34 +02:00			`- LICENSE.md`