diff options
| author | Samy Pessé <samypesse@gmail.com> | 2016-03-09 15:18:57 +0100 |
|---|---|---|
| committer | Samy Pessé <samypesse@gmail.com> | 2016-03-09 15:18:57 +0100 |
| commit | d39f0d6ff01bb033a4afeb1f2eb449f933719b14 (patch) | |
| tree | 4172644a021e28f0eb61c5eaa041bdf2a804d47f /docs | |
| parent | bdbfbf7300ed6df752db996dfd865a695e0532fc (diff) | |
| download | gitbook-d39f0d6ff01bb033a4afeb1f2eb449f933719b14.zip gitbook-d39f0d6ff01bb033a4afeb1f2eb449f933719b14.tar.gz gitbook-d39f0d6ff01bb033a4afeb1f2eb449f933719b14.tar.bz2 | |
Add "output" variables for templating
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/templating/variables.md | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/docs/templating/variables.md b/docs/templating/variables.md index bca5880..8dbab98 100644 --- a/docs/templating/variables.md +++ b/docs/templating/variables.md @@ -12,6 +12,7 @@ The following is a reference of the available data during book's parsing and the | `file` | File associated with the current page specific information | | `summary` | Information about the table of contents | | `languages` | List of languages for multi-lingual books | +| `output` | Information about the output generator | | `config` | Dump of the `book.json` | ### Book Variables @@ -62,3 +63,11 @@ The whole table of contents (`SUMMARY.md`) can be accessed: | `languages.list` | List of languages for this book | Languages are defined by `{ id: 'en', title: 'English' }`. + +### Output Variables + +| Variable | Description | +| -------- | ----------- | +| `output.name` | Name of the output generator, possible values are `website`, `json`, `ebook` | +| `output.format` | When `output.name == "ebook"`, `format` defines the ebook format that will be generated, possible values are `pdf`, `epub` or `mobi` | + |