Clarify the use of {{ book.var }} (#1652)

Fixes #1425
This commit is contained in:
Nicolas Gaborit
2017-01-11 17:41:47 +01:00
committed by Samy Pessé
parent 4b3ac4e827
commit a96ef569bd
+13 -1
View File
@@ -21,8 +21,20 @@ The following is a reference of the available data during book's parsing and the
| Variable | Description |
| -------- | ----------- |
| `book.[CONFIGURATION_DATA]` | All the `variables` set via the `book.json` are available through the book variable. |
| `book.language` | Current language for a multilingual book |
| `book.[value]` | All other values under `variables` in the `book.json` are accessible here |
For example, with this `book.json`:
```json
{
variables: {
hello: "everyone"
}
}
```
... the following text `{{ book.hello }}` will expand to `everyone`.
### GitBook Variables