GitBook Quick Start Guide

使用 Gitbook 写 markdown， GitBook 可以与 github 进行链接，GitBook 在线编辑

本地写 GitBook

安装 Node.js

安装 GitBook

npm install gitbook-cli -g

检查 gitbook 是否安装成功

gitbook -V

初始化目录（创建 SUMMARY.md 和 README.md）

gitbook init {directory}

安装过程中遇到的问题

在执行 gitbook init 出现 TypeError: cb.apply is not a function 错误，其中报错信息包含 polyfills.js 的本地路径，需要修改 js 中的代码

• 进入编辑模式

sudo vim {polyfill.js}

• 注释下面代码

// fs.stat = statFix(fs.stat)
// fs.stat = statFix(fs.fstat)
// fs.stat = statFix(fs.lstat)

后面再次执行 gitbook init 出现了另外一个错误 TypeError [ERR_INVALID_ARG_TYPE]: The "data" argument must be of type string or an instance of Buffer, TypedArray, or DataView. Received an instance of Promise

需要下载 Node.js_v12 然后安装，再次执行 gitbook init 顺利执行

其他指令

• gitbook serve 本地预览默认端口 4000
• gitbook build 生成静态页面

GitBook 内容

一开始会给两个文件

• README.md - 介绍本书的简介
• SUMMARY.md - 本书的文件夹目录结构

GitBook 插件 搜索地址，记录一下本人使用的一些插件，在 book.json 中的配置

    "plugins": [
        "-lunr",
        "-search",
        "-highlight",
        "livereload",
        "-sharing",
        "prism",
        "search-pro",
        "prism-themes",
        "advanced-emoji",
        "splitter",
        "tbfed-pagefooter",
        "favicon",
        "anchor-navigation-ex",
        "popup",
        "copy-code-button",
        "hide-element"
    ],
    "pluginsConfig": {
        "theme-default": {
            "showLevel": false
        },
        "search-pro": {
            "cutWordLib": "nodejieba",
            "defineWord": ["Gitbook Use"]
        },
        "hide-element": {
            "elements": [".gitbook-link"]
        },
        "prism": {
            "css": [
                "prism-themes/themes/prism-lucario.css"
            ]
        },
        "tbfed-pagefooter": {
            "copyright": "Copyright © www.sugrsugr.com 2021",
            "modify_label": "该文件修订时间：",
            "modify_format": "YYYY-MM-DD HH:mm:ss"
        },
        "favicon": {
            "shortcut": "favicon.ico",
            "bookmark": "favicon.ico"
        },
        "anchor-navigation-ex": {
            "showLevel": false,
            "showGoTop": true,
            "isRewritePageTitle": true,
            "isShowTocTitleIcon": true,
            "tocLevel1Icon": "fa fa-hand-o-right",
            "tocLevel2Icon": "fa fa-hand-o-right",
            "tocLevel3Icon": "fa fa-hand-o-right"
        }
    }