diff options
Diffstat (limited to 'docs/templating.md')
-rw-r--r-- | docs/templating.md | 62 |
1 files changed, 59 insertions, 3 deletions
diff --git a/docs/templating.md b/docs/templating.md index c3ab084..38df38e 100644 --- a/docs/templating.md +++ b/docs/templating.md @@ -8,27 +8,83 @@ The Nunjucks syntax is very similar to **Jinja2** or **Liquid**. A variable looks up a value from the template context. If you wanted to simply display a variable, you would do: -``` +```twig {{ 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. -``` +```twig {{ 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 }}`. +GitBook provides a set of [context variables](variables.md). + ### Filters Filters are essentially functions that can be applied to variables. They are called with a pipe operator (`|`) and can take arguments. -``` +```twig {{ 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. + +### Tags + +##### if + +`if` tests a condition and lets you selectively display content. It behaves exactly as javascript's if behaves. + +```twig +{% if variable %} + It is true +{% endif %} +``` + +If variable is defined and evaluates to true, "It is true" will be displayed. Otherwise, nothing will be. + +You can specify alternate conditions with elif and else: + +```twig +{% if hungry %} + I am hungry +{% elif tired %} + I am tired +{% else %} + I am good! +{% endif %} +``` + +##### for + +`for` iterates over arrays and dictionaries. + +```twig +# Chapters about GitBook + +{% for article in glossary.terms['gitbook'].articles %} +* [{{ article.title }}]({{ article.path }}) +{% endfor %} +``` + +##### set + +`set` lets you create/modify a variable. + +```twig +{% set softwareVersion = "1.0.0" %} + +Current version is {{ softwareVersion }}. +[Download it](website.com/download/{{ softwareVersion }}) +``` + +##### include and block + +Inclusion and inheritance is detailled in the [ConRefs](conrefs.md) section. + |