[开发工具]gitbook+ doctoc构建github pages

1、安装doctoc和gitbook

用doctoc生成的目录放到SUMMARY中点击菜单可滑到对应位置

npm i doctoc
// 生成目录
doctoc .

// SUMMARY.md
// #browser-version是doctoc生成的
* [简介](README.md)
* [types](./src/types/README.md)
    * [date](./src/types/README.md#date)
    * [browser](./src/types/README.md#browser)
    * [browser version](./src/types/README.md#browser-version)

2、gitbook编译

1、根目录下创建book.json，并添加常用的配置。
gitbook install下载插件

{
    "title": "utils工具函数",
    "language": "zh-hans", // 简体中文
    "author": "pgli",
    "gitbook": "3.2.3",
    "root": ".",
    "links": { 
    	// 额外的菜单  
        "sidebar": { // 键值对为 菜单名: 访问地址
        }
    },
    "structure": {
        "readme": "README.md"
    },
    // 使用的插件
    "plugins": [
        "chapter-fold", // 菜单可缩起
        "code", // 代码可copy
        "github", // github地址
        "pageview-count", // 访问此处
        "custom-favicon", // 自定义ico
        "hide-element", // 隐藏dom
        "back-to-top-button",  // 返回顶部
        "splitter", // 菜单栏可手动拖动改变宽度
        "-lunr", // 修改默认的查询行为
        "-search",
        "search-pro",
        "-sharing",// 修改默认的分享
        "sharing-plus"
    ],
    "pluginsConfig": {
        "chapter-fold": {},
        "code": {
            "copyButtons": true
        },
        "github": {
            "url": "https://github.com/ligaopeng123-npm/utils"
        },
        "favicon": "./favicon.ico",
        "hide-element": {
            "elements": [
                ".gitbook-link"
            ]
        },
        "sharing": {
            "douban": true,
            "facebook": false,
            "google": false,
            "pocket": false,
            "qq": true,
            "qzone": false,
            "twitter": false,
            "weibo": true,
            "all": [
                "douban",
                "facebook",
                "google",
                "instapaper",
                "linkedin",
                "twitter",
                "weibo",
                "messenger",
                "qq",
                "qzone",
                "viber",
                "whatsapp"
            ]
        }
    }
}

2、build数据到docs目录

gitbook build . docs
// 把创建的docs提交到github上

3、github配置pages