GitBook的使用相較之下還是比較的簡(jiǎn)單,插件也相對(duì)豐富

安裝node.js(使用homebrew安裝即可)

node -v #v12.12.0

安裝gitbook

$ npm install gitbook-cli -g

檢驗(yàn)安裝

gitbook -V
#  CLI version: 2.3.2
#  GitBook version: 3.2.3

創(chuàng)建目錄 test-gitbook

cd test-gitbook
gitbook init
# 可以看到多了README.md  SUMMARY.md 兩個(gè)文件

編輯summary.md

# Summary

* [前言](README.md)
* [JAVA技術(shù)](Chapter1/README.md)
* [GO技術(shù)](Chapter2/README.md)
* [深入理解JVM](Chapter3/README.md)
* [算法知識(shí)](Chapter4/README.md)
* [SPRING系列](Chapter5/README.md)
    * [Spring](Chapter5/Spring.md)
    * [SpringBoot](Chapter5/SpringBoot.md)
    * [SpringCloud](Chapter5/SpringCloud.md)
* [DOCKER](Chapter6/README.md)
* [NETTY](Chapter7/README.md)

生成網(wǎng)頁(yè)并啟動(dòng)gitbook

gitbook serve

# 通過(guò)http://localhost:4000即可訪問(wèn)

如圖所示,就是我們剛創(chuàng)建的目錄

1.png

生成網(wǎng)頁(yè)不啟動(dòng)gitbook

gitbook build 
#默認(rèn)將靜態(tài)頁(yè)面生成在 _book目錄下,如果想指定目錄,比如托管在github上,則需要生成在docs目錄,可以使用以下命令
gitbook build ./ ./docs

目錄結(jié)構(gòu)

再次執(zhí)行g(shù)itbook init,即可看到目錄下初始化了在SUMMARY.md里配置的目錄結(jié)構(gòu)

>Chapter1   
>Chapter2   
>Chapter3   
>Chapter4   
>Chapter5   
>Chapter6   
>Chapter7   
README.md  
SUMMARY.md 
>_book       #此目錄為gitbook build后生成的靜態(tài)頁(yè)面目錄

我們只要在相應(yīng)目錄下添加我們的內(nèi)容即可

插件的使用

Gitbook默認(rèn)自帶有5個(gè)插件：
如果不用可以前面加-去掉
highlight： 代碼高亮
search： 導(dǎo)航欄查詢功能（不支持中文）
sharing：右上角分享功能
fontsettings：字體設(shè)置（最上方的"A"符號(hào)）
livereload：為GitBook實(shí)時(shí)重新加載

如果想使用插件等,我們可以在目錄下創(chuàng)建book.json配置文件,附上我的配置文件

{
    "title": "古道長(zhǎng)亭",  //標(biāo)題
    "author": "古道長(zhǎng)亭", //作者
    "description": "welcome to my docs", //書描述
    "language": "zh-hans", //語(yǔ)言 en, zh-hans, zh-tw
    "gitbook": "3.2.3",  //指定gitbook版本
    "styles": {       //樣式文件
        "website": "./style/website.css"
    },
    "structure": {   //指定 Readme、Summary、Glossary 和 Languages 對(duì)應(yīng)的文件名
        "readme": "README.md"
    },
    "links": {      //左側(cè)導(dǎo)航欄鏈接信息
        "sidebar": {
            "回到博客": "https://blog.zhaojq.top"
        }
    },
    "plugins": [    //插件列表
        "anchors",
        "anchor-navigation-ex",  //給頁(yè)面H1-H6標(biāo)題增加錨點(diǎn)效果,浮動(dòng)導(dǎo)航模式,頁(yè)面內(nèi)頂部導(dǎo)航模式等
        "auto-scroll-table", //表格滾動(dòng)條
        "advanced-emoji",   //支持emoji表情    
        "code", //代碼添加行號(hào)&復(fù)制按鈕
        "chapter-fold", //導(dǎo)航目錄折疊
        "donate", //打賞插件
        "expandable-chapters-small",//可擴(kuò)展導(dǎo)航章節(jié),比toggle-chapters好用
        "favicon", //標(biāo)題欄圖標(biāo)配置
        "fontsettings",   //字體設(shè)置（最上方的"A"符號(hào)）                     
        "github",  //在右上角添加github圖標(biāo)
        "github-buttons",//github按鈕顯示,包括可配置stars數(shù)量等
        "klipse",  //嵌入類似IDE的功能
        "-livereload", //為GitBook實(shí)時(shí)重新加載
        "-lunr", //自帶搜索
        "pageview-count", //閱讀量計(jì)數(shù)
        "page-toc-button", //page-toc-button
        "popup", //彈出大圖
        "sharing-plus", //分享插件
        "-sharing", //自帶分享
        "splitter", //側(cè)邊欄寬度可調(diào)節(jié)
        "-search",  //自帶搜索,前面加-去掉
        "search-pro", //高級(jí)搜索插件 需要將默認(rèn)的search和lunr 插件去掉
        "toggle-chapters", //擴(kuò)展導(dǎo)航章節(jié),由expandable-chapters-small代替
        "tbfed-pagefooter", //頁(yè)面添加頁(yè)腳（簡(jiǎn)單的）
        "todo", //待做項(xiàng)
        "hide-element" //隱藏元素,比如導(dǎo)航欄中Published by GitBook,"elements": [".gitbook-link"]
    ],
    "pluginsConfig": {   //配置插件的屬性
        "github": {
            "url": "https://github.com/zhao-xiaoer"
        },
        "hide-element": {
            "elements": [".gitbook-link"]
        },
        "theme-default": {
            "showLevel": true
        },
        "code": {
            "copyButtons": true
        },
        "tbfed-pagefooter": {
            "copyright": "Copyright ? zhaojq 2019",
            "modify_label": "本書發(fā)布時(shí)間：",
            "modify_format": "YYYY-MM-DD HH:mm:ss"
        },
        "donate": {
            "wechat": "/gitbook/source/images/wechat.jpeg",
            "alipay": "/gitbook/source/images/alipay.jpeg",
            "title": "感謝支持",
            "button": "\uD83D\uDE00",
            "alipayText": "支付寶打賞",
            "wechatText": "微信打賞"
        },
        "github-buttons": {
            "buttons": [{
                "user": "zhao-xiaoer",
                "repo": "gitbook",
                "type": "star",
                "size": "small",
                "count": true
                }
            ]
        },
        "page-toc-button": {
            "maxTocDepth": 2,
            "minTocSize": 2
        },
        "sharing": {
            "douban": false,
            "facebook": false,
            "google": false,
            "hatenaBookmark": false,
            "instapaper": false,
            "line": false,
            "linkedin": false,
            "messenger": false,
            "pocket": false,
            "qq": true,
            "qzone": true,
            "stumbleupon": false,
            "twitter": false,
            "viber": false,
            "vk": false,
            "weibo": true,
            "whatsapp": false,
            "all": [
                "weibo","qq", "qzone", "douban", "facebook","google",
                              "linkedin","twitter","whatsapp"
            ]
        },
        "anchor-navigation-ex": {
            "showLevel": true
        },
        "favicon":{
            "shortcut": "",
            "bookmark": ""
        }
    }
}

使用以下命令安裝插件

gitbook install

發(fā)布

首先build到docs目錄,在github新建一個(gè)工程,例如:gitbook,將gitbook整個(gè)目錄push到github/gitbook,配置個(gè)人域名的方法和hugo的配置一樣,github會(huì)自動(dòng)從docs目錄加載靜態(tài)頁(yè)面.

接下來(lái)你可以通過(guò)個(gè)人域名訪問(wèn)gitbook

我的gitbook地址: https://blog.zhaojq.top/gitbook