mirror/ crowbook
1
0
Fork 0
mirror of https://github.com/lise-henry/crowbook synced 2024-05-25 23:36:09 +02:00
Code Issues

Update config.md

This commit is contained in:
Elisabeth Henry 2016-09-23 02:58:30 +02:00
parent 2f00887d85
commit 5e88e20650
1 changed files with 126 additions and 129 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

255
book_example/config.md
View File

@ -143,7 +143,7 @@ chapter inclusion (that is, a line beginning with '+', '-', 'x.'
Here is the complete list of options, with a short description. The
usage of some of them is detailed later on.
### Metadata ###
### Metadata ###
- **`author`**
- **type**: string
- **default value**: `Anonymous`
@ -169,7 +169,21 @@ usage of some of them is detailed later on.
- **default value**: `not set`
- Path to the cover of the book
### Output options ###
### Additional metadata ###
- **`license`**
- **type**: string
- **default value**: `not set`
- License of the book
- **`version`**
- **type**: string
- **default value**: `not set`
- Version of the book
- **`date`**
- **type**: string
- **default value**: `not set`
- Date the book was revised
### Output options ###
- **`output.epub`**
- **type**: path
- **default value**: `not set`
@ -194,75 +208,41 @@ usage of some of them is detailed later on.
- **type**: path
- **default value**: `not set`
- Output file name for ODT rendering
- **`output.base_path`**
- **type**: path
- **default value**: `""`
- Directory where those output files will we written
### Misc options ###
- **`numbering_template`**
- **type**: string
- **default value**: `"{{number}}. {{title}}"`
- Format of numbered titles
- **`numbering`**
- **type**: integer
- **default value**: `1`
- The maximum heading levels that should be numbered (0: no numbering, 1: only chapters, ..., 6: all)
- **`display_toc`**
### Rendering options ###
- **`rendering.initials`**
- **type**: boolean
- **default value**: `false`
- Use initials ('lettrines') for first letter of a chapter (experimental)
- **`rendering.inline_toc`**
- **type**: boolean
- **default value**: `false`
- Display a table of content in the document
- **`use_initials`**
- **type**: boolean
- **default value**: `false`
- Use initals ('lettrines') for first letter of a chapter (experimental)
- **`toc_name`**
- **`rendering.inline_toc.name`**
- **type**: string
- **default value**: `Table of contents`
- **default value**: `"{{{loc_toc}}}"`
- Name of the table of contents if it is displayed in document
- **`verbose`**
- **type**: boolean
- **default value**: `false`
- Make Crowbook display more messages
- **`rendering.num_depth`**
- **type**: integer
- **default value**: `1`
- The maximum heading levels that should be numbered (0: no numbering, 1: only chapters, ..., 6: all)
- **`rendering.chapter_template`**
- **type**: string
- **default value**: `"{{{number}}}\\. {{{chapter_title}}}"`
- Naming scheme of chapters
### Special option ###
- **`import_config`**
- **type**: path
- **default value**: `not set`
- Import another book configuration file
### HTML options ###
- **`html.highlight_code`**
- **type**: boolean
- **default value**: `true`
- Provides syntax highlighting for code blocks (using highlight.js)
- **`html.highlight.js`**
- **type**: path
- **default value**: `not set`
- Set another highlight.js version than the included one
- **`html.highlight.css`**
- **type**: path
- **default value**: `not set`
- Set another highlight.js CSS theme than the default one
- **`html.template`**
- **type**: path
- **default value**: `not set`
- Path of an HTML template
- **`html.css`**
- **type**: path
- **default value**: `not set`
- Path of a stylesheet for HTML rendering
- **`html.print_css`**
- **type**: path
- **default value**: `not set`
- Path of a media print stylesheet for HTML rendering
- **`html.script`**
- **type**: path
- **default value**: `not set`
- Path of a javascript file
- **`html.display_chapter`**
- **type**: boolean
- **default value**: `false`
- Display only one chapter at a time (with option to display all)
- **`html.side_notes`**
- **type**: boolean
- **default value**: `false`
- Display footnotes as side notes in HTML/Epub (experimental)
- **`html.top`**
### HTML options ###
- **`html.header`**
- **type**: string
- **default value**: `not set`
- Custom header to display at the beginning of html file(s)
@ -270,48 +250,74 @@ usage of some of them is detailed later on.
- **type**: string
- **default value**: `not set`
- Custom footer to display at the end of HTML file(s)
- **`html.crowbook_link`**
- **type**: boolean
- **default value**: `false`
- Display a 'Generated by crowbook' at the end of the document
### Multifile HTML options ###
- **`html_dir.script`**
- **type**: path
- **`html.css`**
- **type**: template path
- **default value**: `not set`
- Path of a stylesheet for HTML rendering
- **`html.js`**
- **type**: template path
- **default value**: `not set`
- Path of a javascript file
- **`html_dir.css`**
- **type**: path
- **`html.css.print`**
- **type**: template path
- **default value**: `not set`
- Path of a CSS template
- Path of a media print stylesheet for HTML rendering
- **`html.highlight_code`**
- **type**: boolean
- **default value**: `true`
- Provides syntax highlighting for code blocks (using highlight.js)
- **`html.highlight.js`**
- **type**: template path
- **default value**: `not set`
- Set another highlight.js version than the bundled one
- **`html.highlight.css`**
- **type**: template path
- **default value**: `not set`
- Set another highlight.js CSS theme than the default one
- **`html.side_notes`**
- **type**: boolean
- **default value**: `false`
- Display footnotes as side notes in HTML/Epub (experimental)
### Standalone HTML options ###
- **`html_single.one_chapter`**
- **type**: boolean
- **default value**: `false`
- Display only one chapter at a time (with a button to display all)
- **`html_single.html`**
- **type**: template path
- **default value**: `not set`
- Path of an HTML template
- **`html_single.js`**
- **type**: template path
- **default value**: `not set`
- Path of a javascript file
### Multifile HTML options ###
- **`html_dir.index.html`**
- **type**: path
- **type**: template path
- **default value**: `not set`
- Path of index.html template
- **`html_dir.chapter.html`**
- **type**: path
- **type**: template path
- **default value**: `not set`
- Path of a chapter.html template
### EPUB options ###
### EPUB options ###
- **`epub.version`**
- **type**: integer
- **default value**: `2`
- EPUB version to generate (2 or 3)
- **`epub.css`**
- **type**: path
- **type**: template path
- **default value**: `not set`
- Path of a stylesheet for EPUB
- **`epub.template`**
- **type**: path
- **`epub.chapter.xhtml`**
- **type**: template path
- **default value**: `not set`
- Path of an xhtml template for each chapter
### LaTeX options ###
- **`tex.short`**
- **type**: boolean
- **default value**: `false`
- Use article class instead of book, and the default `\maketitle` command
### LaTeX options ###
- **`tex.links_as_footnotes`**
- **type**: boolean
- **default value**: `true`
@ -321,29 +327,19 @@ usage of some of them is detailed later on.
- **default value**: `pdflatex`
- LaTeX command to use for generating PDF
- **`tex.template`**
- **type**: path
- **type**: template path
- **default value**: `not set`
- Path of a LaTeX template file
### Advanced options ###
- **`enable_yaml_blocks`**
- **type**: boolean
- **default value**: `false`
- Enable inline YAML blocks to override options set in config file
- **`zip.command`**
- **`tex.class`**
- **type**: string
- **default value**: `zip`
- Command to use to zip files (for EPUB/ODT)
- **`autoclean`**
- **type**: boolean
- **default value**: `true`
- Toggle cleaning of input markdown according to lang
- **`temp_dir`**
- **type**: path
- **default value**: ``
- Path where to create a temporary directory (default: uses result from Rust's std::env::temp_dir())
- **default value**: `book`
- LaTeX class to use
### Resources option ###
### Resources option ###
- **`resources.files`**
- **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.base_path`**
- **type**: path
- **default value**: `not set`
@ -360,45 +356,46 @@ usage of some of them is detailed later on.
- **type**: path
- **default value**: `.`
- Set base path but only for additional files. Useless if resources.base_path is set.
- **`resources.base_path.templates`**
- **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
- **`resources.files`**
### Input options ###
- **`input.autoclean`**
- **type**: boolean
- **default value**: `true`
- Toggle cleaning of input markdown according to lang
- **`input.yaml_blocks`**
- **type**: boolean
- **default value**: `false`
- Enable inline YAML blocks to override options set in config file
### Crowbook options ###
- **`crowbook.temp_dir`**
- **type**: path
- **default value**: ``
- Path where to create a temporary directory (default: uses result from Rust's std::env::temp_dir())
- **`crowbook.zip.command`**
- **type**: string
- **default value**: `not set`
- Whitespace-separated list of files to embed in e.g. EPUB file ; useful for including additional fonts
### Deprecated options ###
- **`base_path`**
- **type**: DEPRECATED
- **default value**: `resources.base_path`
- Renamed
- **`base_path.links`**
- **type**: DEPRECATED
- **default value**: `resources.base_path.links`
- Renamed
- **`base_path.images`**
- **type**: DEPRECATED
- **default value**: `resources.base_path.images`
- Renamed
- **`side_notes`**
- **type**: DEPRECATED
- **default value**: `html.side_notes`
- Renamed
- **`nb_char`**
- **type**: DEPRECATED
- **default value**: `not set`
- Removed
- **default value**: `zip`
- Command to use to zip files (for EPUB/ODT)
- **`crowbook.verbose`**
- **type**: boolean
- **default value**: `false`
- Make Crowbook display more messages
Note that these options have a type, which in most case should be
pretty straightforward (a boolean can be `true` or `false`, an integer
must be composed a number, a string is, well, any string). The `path`
type might puzzle you a
bit, but it's equivalent to a string, except Crowbook will consider it
relatively to the book file.
relatively to the book file. The `template path` type is just the
`path` of a template.
### Output options ###