GitBook 模板

2021-03-02 10:19 更新

這是 GitBook 可使用的模板特性的簡要概述。GitBook 使用 Nunjucks 和  Jinja2 的語法。

轉義

如果你想要輸出任何特殊的目標標簽,你可以使用 raw,其內容都會原樣輸出。

{% raw %}
  這 {{ 不會被處理 }}
{% endraw %}

變量

變量會從書本內容中尋找對應的值。

變量被定義在 ?book.json? 文件中:

{
    "variables": {
        "myVariable": "Hello World"
    }
}

#### 顯示變量

定義在 `book.json` 中的變量可以在 `book` 作用域下被訪問:

這會從書本的變量中尋找 `myVariable` 并顯示它。變量的名字可以存在點 (dot) 來查找屬性。你同樣可以使用方括號語法。

如果對應的值沒有定義,那么什么也不會顯示。下面這些語句不會輸出任何東西,如果 `foo` 沒有定義的話:`{{ book.foo }}`,`{{ book.foo.far }}`,`{{ book.foo.bar.baz }}`。

#### 上下文變量

一些變量也可以用來獲取當前文件或GitBook實例的信息。

| Name | Description |
| ---- | ----------- |
| `file.path` | Path of the file relative to the book |
| `file.mtime` |Last modified date of the file |

## 標簽

標簽是在章節(jié)和模板中執(zhí)行操作的特殊塊

#### If

**if** 測試一個條件并讓你選擇性的顯示內容。它的行為的和編程語言中的if一樣。

`

如果 `variable` 被定義了并且是真的,那么 "It is true" 就會被顯示出來。否則,沒有任何東西會被顯示。

你可以使用elif和else來指定選擇性條件:

I am good!


#### for

**for** 迭代數(shù)組和字典。

讓我們來看一下 `book.json` 中的變量:

{ "variables": { "authors": [ { "name": "Samy" }, { "name": "Aaron" } ] } }



Authors

```

上面的例子使用 authors 數(shù)組的每項的 name 屬性作為顯示的值,列出了所有的作者 (author) 。

include

Include 的詳細描述在文章 內容引用 中。


以上內容是否對您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號