mirror/ crowbook
1
0
Fork 0
mirror of https://github.com/lise-henry/crowbook synced 2024-05-24 18:26:08 +02:00
Code Issues

Update guide to new options

This commit is contained in:
Elisabeth Henry 2016-10-18 00:49:17 +02:00
parent b74d3acd1a
commit 9896994396
2 changed files with 37 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
guide/arguments.md
View File

@ -4,29 +4,29 @@ Arguments
Crowbook can takes a list of arguments:
```text
Render a markdown book in Epub, PDF or HTML.
Render a Markdown book in EPUB, PDF or HTML.
USAGE:
crowbook [FLAGS] [OPTIONS] [--] [BOOK]
crowbook [OPTIONS] [--] [BOOK]
FLAGS:
-h, --help Prints help information
-l, --list-options Lists all possible option
-p, --proofread Enable roofreading
-h, --help Print help information
-l, --list-options List all possible options
-p, --proofread Enable proofreading
-q, --quiet Don't print info/error messages
-s, --single Use a single Markdown file instead of a book configuration file
-V, --version Prints version information
-v, --verbose Print warnings in parsing/rendering
-V, --version Print version information
OPTIONS:
-c, --create <FILES>... Creates a new book with existing markdown files
-o, --output <FILE> Specifies output file
--print-template <TEMPLATE> Displays the default value of a template
--set <KEY_VALUES> Sets a list of book options
-t, --to <FORMAT>
Generate specific format [values: epub, pdf, html, tex, odt, proofread.html, proofread.html_dir, proofread.pdf, proofread.tex]
-c, --create <FILES>... Create a new book with existing Markdown files
-o, --output <FILE> Specify output file
--print-template <TEMPLATE> Prints the default content of a template
--set <KEY_VALUES> Set a list of book options
-t, --to <FORMAT> Generate specific format
ARGS:
<BOOK> File containing the book configuration, or a Markdown file when called with --single
<BOOK> File containing the book configuration file, or a Markdown file when called with --single
```
Note that Crowbook generates output files relatively to the directory

41
guide/config.md
View File

@ -145,25 +145,25 @@ usage of some of them is detailed later on.
### Metadata ###
- **`author`**
- **type**: string
- **type**: metadata
- **default value**: `Anonymous`
- Author of the book
- **`title`**
- **type**: string
- **type**: metadata
- **default value**: `Untitled`
- Title of the book
- **`lang`**
- **type**: string
- **type**: metadata
- **default value**: `en`
- Language of the book
- **`subject`**
- **type**: string
- **type**: metadata
- **default value**: `not set`
- Subject of the book (used for EPUB metadata)
- Subject of the book (used for EPUB metadata
- **`description`**
- **type**: string
- **type**: metadata
- **default value**: `not set`
- Description of the book (used for EPUB metadata)
- Description of the book (used for EPUB metadata
- **`cover`**
- **type**: path
- **default value**: `not set`
@ -171,15 +171,15 @@ usage of some of them is detailed later on.
### Additional metadata ###
- **`license`**
- **type**: string
- **type**: metadata
- **default value**: `not set`
- License of the book
- **`version`**
- **type**: string
- **type**: metadata
- **default value**: `not set`
- Version of the book
- **`date`**
- **type**: string
- **type**: metadata
- **default value**: `not set`
- Date the book was revised
@ -254,6 +254,10 @@ usage of some of them is detailed later on.
- **type**: template path
- **default value**: `not set`
- Path of a stylesheet for HTML rendering
- **`html.css.colours`**
- **type**: template path
- **default value**: `not set`
- Path of a stylesheet for the colours for HTML
- **`html.js`**
- **type**: template path
- **default value**: `not set`
@ -281,7 +285,7 @@ usage of some of them is detailed later on.
- **`html.escape_nb_spaces`**
- **type**: boolean
- **default value**: `true`
- Replace unicode non breaking spaces with HTML entities and CSS
- Replace unicode non breaking spaces with HTML entities and CSS
### Standalone HTML options ###
- **`html_single.one_chapter`**
@ -344,6 +348,10 @@ usage of some of them is detailed later on.
- **type**: string
- **default value**: `not set`
- Whitespace-separated list of files to embed in e.g. EPUB file; useful for including e.g. fonts
- **`resources.out_path`**
- **type**: path
- **default value**: `data`
- Paths where additional resources should be copied in the EPUB file or HTML directory
- **`resources.base_path`**
- **type**: path
- **default value**: `not set`
@ -364,16 +372,16 @@ usage of some of them is detailed later on.
- **type**: path
- **default value**: `.`
- Set base path but only for templates files. Useless if resources.base_path is set.
- **`resources.out_path`**
- **type**: path
- **default value**: `data`
- Paths where additional resources should be copied in the EPUB file or HTML directory
### Input options ###
- **`input.autoclean`**
- **type**: boolean
- **default value**: `true`
- Toggle cleaning of input markdown according to lang
- **`input.smart_quotes`**
- **type**: boolean
- **default value**: `true`
- If enabled, tries to replace vertical quotations marks to curly ones.
- **`input.yaml_blocks`**
- **type**: boolean
- **default value**: `false`
@ -411,7 +419,7 @@ usage of some of them is detailed later on.
- **`proofread`**
- **type**: boolean
- **default value**: `false`
- Activate generation of proofreading copies
- If set to false, will disactivate proofreading even if one of output.proofread.x is present
- **`proofread.nb_spaces`**
- **type**: boolean
- **default value**: `true`
@ -448,7 +456,6 @@ usage of some of them is detailed later on.
- **type**: float
- **default value**: `2.0`
- Threshold to detect a repetition
```
Note that these options have a type, which in most case should be
pretty straightforward (a boolean can be `true` or `false`, an integer