diff options
| author | Samy Pessé <samypesse@gmail.com> | 2016-04-18 12:49:31 +0200 |
|---|---|---|
| committer | Samy Pessé <samypesse@gmail.com> | 2016-04-18 12:49:31 +0200 |
| commit | 0791b917f1191861e6320f48be95441102ae9ac7 (patch) | |
| tree | b60d5c3160ef1ad8a173da86b5a9b428faeb8028 /docs | |
| parent | ba182ce8e430f08bd8c60865b9c853875a3d6483 (diff) | |
| download | gitbook-0791b917f1191861e6320f48be95441102ae9ac7.zip gitbook-0791b917f1191861e6320f48be95441102ae9ac7.tar.gz gitbook-0791b917f1191861e6320f48be95441102ae9ac7.tar.bz2 | |
Add context for readme
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/templating/variables.md | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/docs/templating/variables.md b/docs/templating/variables.md index 8dbab98..9499c8e 100644 --- a/docs/templating/variables.md +++ b/docs/templating/variables.md @@ -10,6 +10,8 @@ The following is a reference of the available data during book's parsing and the | `gitbook` | GitBook specific information | | `page` | Current page specific information | | `file` | File associated with the current page specific information | +| `readme` | Information about the Readme | +| `glossary` | Information about the Glossary | | `summary` | Information about the table of contents | | `languages` | List of languages for multi-lingual books | | `output` | Information about the output generator | @@ -71,3 +73,14 @@ Languages are defined by `{ id: 'en', title: 'English' }`. | `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` | +### Readme Variables + +| Variable | Description | +| -------- | ----------- | +| `readme.path` | Path to the Readme in the book | + +### Glossary Variables + +| Variable | Description | +| -------- | ----------- | +| `glossary.path` | Path to the Glossary in the book | |