diff options
Diffstat (limited to 'docs/templating.md')
| -rw-r--r-- | docs/templating.md | 30 |
1 files changed, 28 insertions, 2 deletions
diff --git a/docs/templating.md b/docs/templating.md index 0c0f5af..c3ab084 100644 --- a/docs/templating.md +++ b/docs/templating.md @@ -1,8 +1,34 @@ # Templating -GitBook uses the Nunjucks templating language to process pages and templates. +GitBook uses the Nunjucks templating language to process pages and theme's templates. -The Nunjucks syntax is very similar to Jinja2 and Liquid. +The Nunjucks syntax is very similar to **Jinja2** or **Liquid**. +### Variables +A variable looks up a value from the template context. If you wanted to simply display a variable, you would do: +``` +{{ username }} +``` + +This looks up username from the context and displays it. Variable names can have dots in them which lookup properties, just like javascript. You can also use the square bracket syntax. + +``` +{{ foo.bar }} +{{ foo["bar"] }} +``` + +If a value is undefined, nothing is displayed. The following all output nothing if foo is undefined: `{{ foo }}`, `{{ foo.bar }}`, `{{ foo.bar.baz }}`. + +### Filters + +Filters are essentially functions that can be applied to variables. They are called with a pipe operator (`|`) and can take arguments. + +``` +{{ foo | title }} +{{ foo | join(",") }} +{{ foo | replace("foo", "bar") | capitalize }} +``` + +The third example shows how you can chain filters. It would display "Bar", by first replacing "foo" with "bar" and then capitalizing it. |