diff options
author | Samy Pessé <samypesse@gmail.com> | 2015-01-26 10:32:19 +0100 |
---|---|---|
committer | Samy Pessé <samypesse@gmail.com> | 2015-01-26 10:32:19 +0100 |
commit | decd8dbdc50c41be2c3394019ece146e4ccfb507 (patch) | |
tree | 22a41f988a885584453abb3aec304a277715811d /README.md | |
parent | edc954f2ac0b13e13de68a686221e883747a9b7f (diff) | |
download | gitbook-decd8dbdc50c41be2c3394019ece146e4ccfb507.zip gitbook-decd8dbdc50c41be2c3394019ece146e4ccfb507.tar.gz gitbook-decd8dbdc50c41be2c3394019ece146e4ccfb507.tar.bz2 |
Add infos in readme about variables and templating
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 34 |
1 files changed, 34 insertions, 0 deletions
@@ -113,6 +113,40 @@ With it's definition, this can contain bold text and all other kinds of inline m #### Variables and Templating +A set of variables can be defined in the `book.json`: + +```js +{ + "variables": { + "host": "mybook.com" + } +} +``` + +These variables can be used in the markdown files: + +``` +The host is {{ book.host }} +``` + +You can also use condition with these variables: + +``` +{% if book.host == "mybook.com" %} + +{% else %} + +{% endif %} +``` + +Variables of `book.json` are available in the `book` namespace. You can also access informations about the `file` itself and the `gitbook` version: + +``` +My file is {{ file.path }} +Modified at {{ file.mtime }} +Book built with GitBook {{ gitbook.version }} +``` + #### Content References You can use "content references," or conrefs, when writing books or documentation using GitBook. |