mirror of
https://github.com/lise-henry/crowbook
synced 2024-05-09 15:56:10 +02:00
85 lines
1.9 KiB
Plaintext
85 lines
1.9 KiB
Plaintext
# 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.13.0
|
|
date: 2017-07-14
|
|
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: 2
|
|
rendering.initials: false
|
|
rendering.inline_toc: false
|
|
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 colours
|
|
html.css.colours: guide/colours.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/arguments.md
|
|
+ guide/config.md
|
|
+ guide/markdown.md
|
|
+ guide/templates.md
|
|
+ guide/proofreading.md
|
|
+ guide/if.md
|
|
+ guide/misc.md
|
|
+ guide/contribute.md
|
|
- ChangeLog.md
|
|
- LICENSE.md
|
|
|