模板与变量

1.模板

• Gitbook 可以使用模板来扩展定制化功能
• Gitbook 可以使用 Nunjucks 和 jinja2 的语法
• 熟悉 Python Web 开发会比较熟悉 jinja2
• jinja2 语法简单，主要使用 {} 来标记需要处理的内容

1.1.jinja2语法

• jinja2 主要有两种语法:

  • 1.控制结构(if、for): {% %}
  • 2.变量取值: {{ var }}

• 1.控制结构

  • if: 与多数编程语言一样

# if
{% if var %}
    变量为: var
{% endif %}

# if elase
{% if var1 %}
    var1: var
{% elif var2 %}  
    var1: var
{% else %}
    unknow: var
{% endif %}

• for: 类似于shell和python

{% for item in items %}
    item: {{ item }}
{% endfor %}

1.2.转义

• 如果想原样输出内容，则可以进行转义
• 比如在写这篇时，就需要将这一部分转义

{% raw %}
   原样输出 {{ 原样输出 }}
{% endraw %}

2.变量

• Gitbook 变量主要包括: 全局变量、Book变量、Gitbook变量、File变量、Page变量、其他变量

2.1.全局变量

• Gitbook 内置了很多全局变量

2.2.Book变量

• 该变量主要是 book.json 中配置的数据。如果想自定义变量，Book变量是最佳选择

• 可以在book.json增加自定义变量: variables

{
    "variables": {
        "key1": "value1",
        "key2": "value2",
        "key3": "value3"
    }
}

2.3.Gitbook变量

• 该变量用来获取生成 book 的 gitbook 的基本信息

2.4.File变量

• 该变量用来获取此文件的相关信息

2.5.Page变量

• 该变量用来获取当前页面的信息

2.6.其他变量