【Gitbook】實用配置及插件介紹

前言

實際效果可以查看這里
github地址

配置

title

設置書本的標題

"title" : "Gitbook Use"

author

作者的相關信息

"author" : "zhangjikai"

description

本書的簡單描述

"description" : "記錄Gitbook的配置和一些插件的使用"

language

Gitbook使用的語言, 版本2.6.4中可選的語言如下：

en, ar, bn, cs, de, en, es, fa, fi, fr, he, it, ja, ko, no, pl, pt, ro, ru, sv, uk, vi, zh-hans, zh-tw

配置使用簡體中文

"language" : "zh-hans",

links

在左側導航欄添加鏈接信息

"links" : {
    "sidebar" : {
        "Home" : "http://zhangjikai.com"
    }
}

styles

自定義頁面樣式， 默認情況下各generator對應的css文件

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

例如使<h1> <h2>標簽有下邊框， 可以在website.css中設置

h1 , h2{
    border-bottom: 1px solid #EFEAEA;
}

plugins

配置使用的插件

"plugins": [
    "disqus"
]

添加新插件之間需要運行gitbook install來安裝新的插件

Gitbook默認帶有5個插件：

• highlight
• search
• sharing
• font-settings
• livereload

如果要去除自帶的插件， 可以在插件名稱前面加-

"plugins": [
    "-search"
]

pluginsConfig

配置插件的屬性

"pluginsConfig": {
    "fontsettings": {
        "theme": "sepia",
        "family": "serif",
        "size":  1
    }
}

插件

記錄一些實用的插件

Disqus

添加disqus評論

插件地址

"plugins": [
    "disqus"
],
"pluginsConfig": {
    "disqus": {
        "shortName": "gitbookuse"
    }
}

Search Pro

支持中文搜索, 需要將默認的search插件去掉, 注意: 如果標題中有包含的關鍵字, 標題的樣式會有所變化
插件地址

"plugins": [
    "-search",
    "search-pro"
],
"pluginsConfig": {
    "search-pro": {
        "cutWordLib": "nodejieba",
        "defineWord" : ["Gitbook Use"]
    }
}

Advanced Emoji

支持emoji表情
emoij表情列表
插件地址

"plugins": [
    "advanced-emoji"
]

使用示例

Github

添加github圖標
插件地址

"plugins": [ 
    "github" 
],
"pluginsConfig": {
    "github": {
        "url": "https://github.com/zhangjikai"
    }
}

Ace Plugin

使gitbook支持ace
插件地址

"plugins": [
    "ace"
]

使用示例

Emphasize

為文字加上底色
插件地址

"plugins": [
    "emphasize"
]

使用示例

KaTex

為了支持數學公式, 我們可以使用KaTex和MathJax插件, 官網上說Katex速度要快於MathJax
插件地址
MathJax使用LaTeX語法編寫數學公式教程

"plugins": [
    "katex"
]

使用示例

Include Codeblock

使用代碼塊的格式顯示所包含文件的內容. 該文件必須存在.
插件地址

"plugins": [
    "include-codeblock"
]

使用示例

Splitter

使側邊欄的寬度可以自由調節

插件地址

"plugins": [
    "splitter"
]

Mermaid

支持渲染Mermaid圖表
插件地址

"plugins": [
    "mermaid"
]

使用示例

Sharing

分享當前頁面, gitbook的默認插件, 使用下面方式來禁用

 plugins: ["-sharing"]

配置:

"pluginsConfig": {
    "sharing": {
        "weibo": true,
        "facebook": true,
        "twitter": true,
        "google": false,
        "instapaper": false,
        "vk": false,
        "all": [
            "facebook", "google", "twitter",
                "weibo", "instapaper"
        ]
    }
}

Tbfed-pagefooter

為頁面添加頁腳
插件地址

"plugins": [
   "tbfed-pagefooter"
],
"pluginsConfig": {
    "tbfed-pagefooter": {
        "copyright":"Copyright &copy zhangjikai.com 2015",
        "modify_label": "該文件修訂時間：",
        "modify_format": "YYYY-MM-DD HH:mm:ss"
    }
}

Toggle Chapters

是左側的章節目錄可以折疊
插件地址

"plugins": ["toggle-chapters"]

Sectionx

將頁面分塊顯示
插件地址

"plugins": [
   "sectionx"
]

使用示例

Codeblock-filename

為代碼塊添加文件名稱
插件地址

plugins: [ "codeblock-filename" ] 

使用示例

ga

google 統計
插件地址

"plugins": [
    "ga"
 ],
"pluginsConfig": {
    "ga": {
        "token": "UA-XXXX-Y"
    }
}

baidu

百度統計
插件地址

"plugin": [
    "baidu"
 ],
"pluginsConfig": {
    "baidu": {
        "token": "YOUR TOKEN"
    }
}