2016-02-23 22:50:37 +01:00
|
|
|
# Metadata
|
2016-09-22 06:59:22 +02:00
|
|
|
author: "Élisabeth Henry"
|
2016-09-16 21:36:48 +02:00
|
|
|
title: Crowbook User Guide
|
2016-03-01 21:41:23 +01:00
|
|
|
description: >-
|
2016-02-27 04:41:38 +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.
|
2016-09-22 20:45:32 +02:00
|
|
|
lang: en
|
2016-09-23 02:36:53 +02:00
|
|
|
cover: cover.png
|
2016-12-20 22:58:33 +01:00
|
|
|
version: 0.11.0
|
|
|
|
|
date: "20th of december, 2016"
|
2016-09-22 06:59:22 +02:00
|
|
|
|
2016-09-23 02:36:53 +02:00
|
|
|
# Options for generating files
|
|
|
|
|
output.epub: book.epub
|
|
|
|
|
output.html: book.html
|
|
|
|
|
output.html_dir: html
|
|
|
|
|
output.pdf: book.pdf
|
|
|
|
|
output.odt: book.odt
|
2016-09-27 03:35:11 +02:00
|
|
|
|
2016-09-23 03:34:31 +02:00
|
|
|
output.base_path: docs/book/
|
2016-09-27 03:35:11 +02:00
|
|
|
output.proofread.html: book.proof.html
|
2016-09-28 06:21:47 +02:00
|
|
|
output.proofread.html_dir: html_proof
|
2016-09-28 01:28:32 +02:00
|
|
|
output.proofread.pdf: book.proof.pdf
|
2016-02-19 21:35:49 +01:00
|
|
|
|
2016-09-23 02:36:53 +02:00
|
|
|
# Resources options
|
|
|
|
|
resources.base_path.images: img/ # where to find the cover
|
2016-09-18 01:39:50 +02:00
|
|
|
|
2016-09-28 06:21:47 +02:00
|
|
|
proofread.repetitions: false
|
2016-09-28 01:28:32 +02:00
|
|
|
proofread.languagetool: true
|
2016-09-27 03:35:11 +02:00
|
|
|
|
2016-09-23 02:36:53 +02:00
|
|
|
# Rendering options
|
2016-09-22 20:45:32 +02:00
|
|
|
rendering.num_depth: 2
|
2016-09-27 03:35:11 +02:00
|
|
|
rendering.initials: false
|
2016-09-22 20:45:32 +02:00
|
|
|
rendering.inline_toc: false
|
2016-12-22 17:43:09 +01:00
|
|
|
rendering.chapter.template: "{{{number}}}\\. {{{chapter_title}}}"
|
|
|
|
|
rendering.chapter.roman_numerals: false
|
2016-09-22 15:35:38 +02:00
|
|
|
|
2016-09-23 02:36:53 +02:00
|
|
|
# Html options
|
2016-12-16 02:37:56 +01:00
|
|
|
html.icon: crowbook.svg
|
2016-09-23 02:36:53 +02:00
|
|
|
html_single.one_chapter: true
|
2016-10-06 23:10:11 +02:00
|
|
|
html.header: "{{{title}}} {{{version}}}"
|
2016-09-23 02:36:53 +02:00
|
|
|
html.footer: "Generated by [Crowbook](https://github.com/lise-henry/crowbook) {{{crowbook_version}}}"
|
2016-09-14 01:28:29 +02:00
|
|
|
|
2016-10-06 19:36:34 +02:00
|
|
|
# Custom colours
|
2016-10-06 23:05:19 +02:00
|
|
|
html.css.colours: guide/colours.css
|
2016-10-07 00:24:24 +02:00
|
|
|
html.highlight.css: guide/tomorrow-night.css
|
2016-10-06 19:36:34 +02:00
|
|
|
|
2016-02-21 05:29:40 +01:00
|
|
|
# Latex options
|
2016-09-22 20:45:32 +02:00
|
|
|
tex.class: book
|
2016-02-21 05:29:40 +01:00
|
|
|
tex.links_as_footnotes: false
|
2016-02-19 21:35:49 +01:00
|
|
|
|
2016-09-23 02:36:53 +02:00
|
|
|
# Epub options
|
2016-02-21 05:29:40 +01:00
|
|
|
epub.version: 3
|
2016-02-20 03:41:29 +01:00
|
|
|
|
2016-02-21 05:29:40 +01:00
|
|
|
|
2016-02-23 22:50:37 +01:00
|
|
|
# Finally, our files.
|
|
|
|
|
# Paths are relative to the directory where this file is
|
2016-12-22 17:43:09 +01:00
|
|
|
@ User guide
|
2016-02-26 23:16:32 +01:00
|
|
|
+ README.md
|
2016-10-06 23:05:19 +02:00
|
|
|
+ guide/arguments.md
|
|
|
|
|
+ guide/config.md
|
|
|
|
|
+ guide/templates.md
|
|
|
|
|
+ guide/proofreading.md
|
2016-12-22 17:43:09 +01:00
|
|
|
@ More info
|
2016-10-06 23:05:19 +02:00
|
|
|
+ guide/misc.md
|
2016-12-18 23:25:52 +01:00
|
|
|
+ guide/contribute.md
|
2016-12-22 17:43:09 +01:00
|
|
|
@ Appendix
|
2016-02-26 23:37:55 +01:00
|
|
|
- ChangeLog.md
|
2016-10-06 19:36:34 +02:00
|
|
|
- LICENSE.md
|
2016-12-22 17:43:09 +01:00
|
|
|
|
