Templates

guidebook supports Nunjucks/Jinja2 template syntax in Markdown files, powered by the Tera template engine.

Variables

Define variables in book.json and use them in Markdown:

{
    "variables": {
        "version": "2.0.0",
        "appName": "My App"
    }
}

Current version: {{ book.version }}

Welcome to {{ book.appName }}!

Conditionals

{% if book.version %}
Version: {{ book.version }}
{% else %}
Version not set
{% endif %}

{% elif %} is also supported.

Loops

{% for item in book.features %}
- {{ item }}
{% endfor %}

The loop.index variable is available inside loops (1-based).

Filters

Example:

{{ book.appName | upper }}
{{ book.subtitle | default(value="No subtitle") }}

Code Block Protection

Template syntax inside code blocks (` and ```) is not processed. This lets you document template syntax without it being evaluated.