last modified by zhoutianju , 2023-06-02 00:54:42

安装 GitBook

前提

• node（<=v10.23.2 一定要注意版本，否则安装可能报错!!!）、npm
• cnpm（可选，后面会提到如果使用了插件，可加速插件安装速度）

mac 环境切换版本可参考：brew 安装指定版本的软件

安装（全局，非工程级别）

npm install -g gitbook-cli # 注意不是 gitbook 这个已经过时了
gitbook -v # 会进初始化安装，gitbook 不会继承 npm 全局的源配置，暂时没有找到加速的方法，不过就执行一次

插件安装加速（工程级别，如果配置了更快的 npm 源或安装了 cnpm 的话）

如果工程中使用了 gitbook 的插件，打包的时候会报错，需要先 gitbook install，其实就是从 npm 源安装这些插件，但 gitbook 命令不会继承 npm 全局的源配置，因此下载很慢，可直接在工程根目录下执行（以 cnpm 为例） cnpm install gitbook-plugin-xxx 安装，xxx 即工程中 book.json 中声明的插件名字，例如 book.json 配置如下：

{
    "title": "个人笔记",
    "plugins": [
        "-lunr",
        "-search",
        "search-plus",
        "-sharing",
        "github@2.0.0",
        "mermaid-gb3",
        "favicon",
        "hide-element",
        "signature",
        "code",
        "chapter-fold",
        "anchor-navigation-ex"
    ],
    "language": "zh-hans",
    "pluginsConfig": {
        "github": {
            "url": "https://github.com/zhoutianju/note"
        },
        "favicon": {
            "shortcut": "/asset/favicon.ico",
            "bookmark": "/asset/favicon.ico"
        },
        "hide-element": {
            "elements": [
                ".gitbook-link"
            ]
        },
        "gitbook-plugin-signature": {
            "autoTimeStamp": {
                "color": "gray",
                "timeStampFormat": "YYYY-MM-DD HH:mm:ss"
            },
            "autoCopyright": {
                "color": "gray",
                "owner": "zhoutianju"
            }
        },
        "anchor-navigation-ex": {
            "showLevel": false,
            "printLog": true,
            "associatedWithSummary": false,
            "multipleH1": false,
            "mode": "float"
        }
    }
}

可使用如下命令安装插件

cnpm install gitbook-plugin--lunr
cnpm install gitbook-plugin--search
cnpm install gitbook-plugin-search-plus
cnpm install gitbook-plugin--sharing
cnpm install gitbook-plugin-github@2.0.0
cnpm install gitbook-plugin-mermaid-gb3
cnpm install gitbook-plugin-favicon
cnpm install gitbook-plugin-hide-element
cnpm install gitbook-plugin-signature
cnpm install gitbook-plugin-code
cnpm install gitbook-plugin-chapter-fold
cnpm install gitbook-plugin-anchor-navigation-ex