summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorNicolas Gaborit <soreine.plume@gmail.com>2017-01-11 17:41:47 +0100
committerSamy Pessé <samypesse@gmail.com>2017-01-11 17:41:47 +0100
commita96ef569bdc9d48ff344c19e9df39e2c4560ff68 (patch)
tree98e561490550cf861f08055c301ca59be2a26a4d
parent4b3ac4e82752694d47a8c2e700a753fb64fec808 (diff)
downloadgitbook-a96ef569bdc9d48ff344c19e9df39e2c4560ff68.zip
gitbook-a96ef569bdc9d48ff344c19e9df39e2c4560ff68.tar.gz
gitbook-a96ef569bdc9d48ff344c19e9df39e2c4560ff68.tar.bz2
Clarify the use of {{ book.var }} (#1652)
Fixes #1425
-rw-r--r--docs/templating/variables.md14
1 files changed, 13 insertions, 1 deletions
diff --git a/docs/templating/variables.md b/docs/templating/variables.md
index 1a215de..0d316df 100644
--- a/docs/templating/variables.md
+++ b/docs/templating/variables.md
@@ -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