Mac搭建gitbook教程（实战记录）

环境 nvm 安装

• 由于gitbook更新缓慢,需要的node 和npm版本需要多个版本 这是需要nvm来对版本管理

$ brew install nvm

测试nvm

• 温馨提示:如果你有安装anaconda python包管理 需要退出base 环境 ,因为nodejs依赖python2.7

$ conda deactivate

$ nvm -v // nvm版本号为 0.37.2
$ nvm ls // 列出本地已安装好的nodejs版本
$ nvm install 6 // 或者nvm install v10.23.0
$ nvm use 6 // 全局切换版本，若提示还未安装nodejs v6，则install
$ nvm current // 查看当前使用的node版本
$ nvm ls-remote // 远程可以安装的所有node版本号

nodejs 安装

• nodejs 需要安装两个版本

$ nvm ls // 查看本地是否有node6/10版本，若无则安装，如下
$ nvm install 6
$ nvm install 10

• 查看版本

$ nvm ls
$ nvm current
$ node --version
v4.2.3
$ npm --version
2.14.7

npm 用法

npm搜索模块
*【npm search xxx】要翻墙，要么直接上www.npmjs.com 搜索；
npm安装模块
*【npm install xxx】利用 npm 安装xxx模块到当前命令行所在目录；
*【npm install -g xxx】利用npm安装全局模块xxx；
*【npm install xxx@3.21.2】npm安装指定版本的包；
本地安装时将模块写入package.json中：
*【npm install xxx】安装但不写入package.json；
*【npm install xxx –save】 安装并写入package.json的”dependencies”中；
*【npm install xxx –save-dev】安装并写入package.json的”devDependencies”中。
npm 删除模块
【npm uninstall xxx】删除xxx模块；
【npm uninstall -g xxx】删除全局模块xxx；

安装gitbook-cli

$ nvm use 10 // 切换nodejs版本，方便顺利安装gitbook-cli
$ npm search gitbook-cli
$ sudo npm install -g gitbook-cli // -g全局，安装命令行版gitbook-cli
$ gitbook -V //查看版本号，看是否安装成功
$ gitbook fetch 2.6.9 // 再安装2.6.9，用该版本build出来的书籍点击目录可以跳转
$ gitbook ls

• 其他基本 *** 作:

$ gitbook versions 显示本地目前可用的GitBook版本；
$ gitbook versions:available 显示有哪些可以安装的版本；
$ gitbook versions:install latest 安装最新版本；
$ gitbook versions:install 2.3.3 安装指定版本；
$ gitbook versions:uninstall 2.3.3 卸载指定版本
$ gitbook -V 查看版本号
$ gitbook ls 列出本地所有的gitbook版本
$ gitbook init 初始化
$ gitbook install 安装插件
$ gitbook serve 预览
$ gitbook build 生成
$ gitbook build --gitbook=2.6.7 生成时指定gitbook的版本, 本地没有会先下载
$ gitbook uninstall 3.2.3 卸载指定版本号的gitbook
$ gitbook fetch [version] 获取[版本]下载并安装<版本>
$ gitbook --help 显示gitbook-cli帮助文档
$ gitbook help 列出 gitbook 所有的命令
$ gitbook ls-remote 列出NPM上的可用版本：

书籍初始化

$ nvm use 6
$ gitbook init

执行完后，如果文件夹里没有这两个文件，会自动生成：
README.md（书籍的介绍在这个文件里）
SUMMARY.md（书籍的目录结构在这里配置）

插件安装

• 生成目录插件
  • gitbook-plugin-summary
  • 安装脚本 $ npm i gitbook-plugin-summary --save

自动生成目录

• SUMMARY.md 模板

# Summary
* [Introduction](README.md)
* [Read](Read/README1.md)
* [1. 季节](季节/ReadMe2.md)
    * [1.1 春](季节/section0.md)
    * [1.2 夏](季节/section1.md)
* [2. 城市](城市/ReadMe3.md)
    * [1.1 北京](城市/section0.md)
    * [1.2 上海](城市/section1.md)

book.json 配置文件

{
    "title": "opencv",
    "output.name": "site",
    "language": "zh-hans",
    "gitbook": "2.6.9", // gitbook版本
    "root": ".",
    "plugins": [
        "code",
        "splitter",
        "chapter-fold",
        "-summary"
    ],
    "pluginsConfig": {
        "code": {
            "copyButtons": true
        }
    }
}

# 每次目录变动都需要执行 gitbook init 更新目录

发布

$ gitbook serve

• 根据提示在浏览器中输入 http://localhost:4000即可浏览

导出书籍

// 对应gitbook2.6.7和2.6.9
$ nvm use 6
// 解决点击目录不能跳转
$ gitbook build --gitbook=2.6.9 书籍路径 输入路径
//gitbook build 书籍路径 输入路径