GitBook 之旅

GitBook 之旅

爲了方便管理，查閱.md文檔，決定訂冊成書，使用 GitBook 生成靜態網站，方便隨意部署。

GitBook 已經很是出名，再也不多複述，下面列出經常使用官方地址：

1. GitBook 官方 github 倉庫地址
2. GitBook 官方文檔地址
3. GitBook 官方插件地址

安裝

安裝其實很簡單，再也不復述，查閱官方文檔內說明便可，而且不用擔憂由於版本的問題，出現的各類緣由！

本文撰寫版本爲：3.2.3

基本目錄結構

*默認必需要的文件。

.						// 根目錄
├── book.json           // 配置文件，默認沒有，須要新建
├── README.md           // * 對應書的前言說明
├── SUMMARY.md			// * 對應目錄，用插件自動生成
├── chapter-1/          // 子級文件夾
|   ├── README.md       // 子級文件夾說明,若是沒有該文件,子頁面無介紹，不可點擊
|   └── 1.md    		// 子頁面
└── chapter-2/
    ├── README.md
    └── 1.md

基本命令

1. 安裝完成，能夠初始化一個模版，能夠查看基本目錄

   $ gitbook init

2. 編譯，並啓動http服務，可在瀏覽器內預覽

   $ gitbook serve

3. 只進行編輯輸出

   $ gitbook build

4. 安裝插件

   $ gitbook install

配置文件

記錄Gitbook的一些基本配置信息。

title-設置書本的標題

{"title" : "Gitbook Use"}

author-做者的相關信息

{"author" : "zhangjikai"}

description-本書的簡單描述

{"description" : "本書的簡單描述"}

language-使用的語言

{"language" : "zh-hans"}

root-指定存放 GitBook 文件（除了 book.json）的根目錄

{"root": "."}

links-在左側導航欄添加連接信息

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

plugins-配置使用的插件

*設置完成後，記得執行安裝命令

{
    "plugins": [
    	"fontsettings"
	]
}

pluginsConfig-配置插件的屬性

*設置完成後，記得執行安裝命令

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

插件

豐富的插件才能構建出功能強大的GitBook。下面列表爲實測可用插件。

summary 目錄自動生成

{
    "plugins": [
        "summary"
	]
}

search-plus 搜索插件

支持中文!

{
    "plugins": [
        "-lunr",
        "-search",
        "search-plus"
	]
}

advanced-emoji 😄表情支持

😄

{
    "plugins": [
        "advanced-emoji"
	]
}

Splitter 使側邊欄的寬度能夠自由調節

{
    "plugins": [
        "splitter"
    ]
}

Mermaid-gb3 支持渲染Mermaid圖表

{
    "plugins": [
        "mermaid-gb3"
    ]
}

tbfed-pagefooter 頁面添加頁腳

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

copy-code-button 爲代碼塊添加複製的按鈕

{
    "plugins": ["copy-code-button"]
}

anchor-navigation-ex-toc 右側頁面導航條與回滾到頂部

{
    "plugins": ["anchor-navigation-ex-toc"]
}