GitBook 配置

所有的配置都以 JSON 格式存儲在名為 ?book.json? 的文件中。

你可以粘貼你的 book.json 去 jsonlint.com 驗證 JSON 語法。

字段

gitbook

{ "gitbook": ">=2.0.0" }

這個選項是用來探測生成書本的 GitBook 的版本。格式是一個 SEMVER 條件。

在 gitbook.com 中，這個值是根據平臺中輸入的標題定義的。

description

{ "description": "This is such a great book!" }

這個選項定義了書本的描述，默認是從 README（第一段）中提取的。

在 gitbook.com 中，這個值是根據平臺輸入的描述定義的。

isbn

{ "isbn": "978-3-16-148410-0" }

這個選項定義了你書本的ISBN。

language

{ "language": "en" }

這個選項定義了你書本的語言，默認值是 en (英語)。

這個值是用來做國際化和本地化的，它改變網站的文字。

在 gitbook.com 中，這個值是根據探測到的語言或指定的設置定義的。

direction

{ "direction": "rtl" }

這個選項是用來重新設置語言的文字方向的。建議將 language 字段設置為帶有正確的文字方向的語言。

styles

這個選項是用來自定義書本的 css 的。

例子：

{
    "styles": {
        "website": "styles/website.css",
        "ebook": "styles/ebook.css",
        "pdf": "styles/pdf.css",
        "mobi": "styles/mobi.css",
        "epub": "styles/epub.css"
    }
}

plugins

{ "plugins": ["mathjax"] }

書本使用的插件列表被定義在 ?book.json? 的配置中。

pluginsConfig

{
    "plugins": ["myplugin"],
    "pluginsConfig": {
        "myPlugin": {
            "message": "Hello World"
        }
    }
}

structure

這個選項是用來覆蓋 GitBook 使用的路徑的。

例如你想要使用 INTRO.md 代替 README.md：

{
    "structure": {
        "readme": "INTRO.md"
    }
}

variables

{
    "variables": {
        "myTest": "Hello World"
    }
}

這個選項定義在 模板 中使用的變量值。