summaryrefslogtreecommitdiffstats
path: root/docs/variables.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/variables.md')
-rw-r--r--docs/variables.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/variables.md b/docs/variables.md
index aaa9601..879c646 100644
--- a/docs/variables.md
+++ b/docs/variables.md
@@ -11,6 +11,7 @@ The following is a reference of the available data during book's parsing and the
| `page` | Current page specific information |
| `file` | File associated with the current page specific information |
| `summary` | Information about the table of contents |
+| `languages` | List of languages for multi-lingual books |
| `config` | Dump of the `book.json` |
### Book Variables
@@ -53,3 +54,10 @@ Thw whole table of contents (`SUMMARY.md`) can be accessed:
`summary.parts[0].articles[0].title` will return the title of the first article.
+#### Multi-lingual book Variable
+
+| Variable | Description |
+| -------- | ----------- |
+| `languages.list` | List of languages for this book |
+
+Languages are defined by `{ id: 'en', title: 'English' }`.