guidebook 0.1.73

HonKit/GitBook compatible static book generator
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65

# 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:

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

```markdown
Current version: {{ book.version }}

Welcome to {{ book.appName }}!
```

## Conditionals

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

`{% elif %}` is also supported.

## Loops

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

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

## Filters

| Filter | Description |
|--------|-------------|
| `upper` | Convert to uppercase |
| `lower` | Convert to lowercase |
| `capitalize` | Capitalize first letter |
| `length` | Get the length |
| `default(value="fallback")` | Provide a fallback value |

Example:

```markdown
{{ 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.