Gitbook的安装与使用

GitBook for Mac

GitBook 是一个基于 Node.js 的命令行工具，可使用 Markdown 来制作精美的电子书。
公司采用 GitBook 为接口文档撰写工具。

Mac 下安装 GitBook

---

1. Mac 需要先安装 Homebrew
   安装方法及地址： http://brew.sh/index_zh-cn.html
2. 使用 Homebrew 安装Node.js
   使用终端运行：
   brew install node
3. 使用 npm 安装 gitbook :
   npm install -g gitbook-cli --registry=https://registry.npm.taobao.org
   使用 淘宝源 或 翻墙 (Mac 下推荐鱼摆摆 https://ybb1024.com)

Win 下安装 GitBook

---

1. Win 需要先安装 Node.js
   安装包下载地址： https://nodejs.org/en/download/
   选择 Windows Installer (.msi) 相应版本下载；
2. 使用 npm 安装 gitbook :
   打开 cmd 运行:
   npm install -g gitbook-cli --registry=https://registry.npm.taobao.org

使用 GitBook

---

1. 新建一个文件夹，如 XuhaiBook

2. 使用终端进入 XuhaiBook
   打开终端输入 cd 空格 ，将新建文件夹拖入终端界面中，回车进此文件夹；

3. 初始化 GitBook
   在终端中输入 gitbook init
   命令执行完毕后在 XuhaiBook 文件夹中会生成两个文件:
   README.md - GitBook的主页.
   SUMMARY.md - 定义了GitBook的结构. 它包含章节的列表,以及它们的链接.

4. 编写 GitBook
   GitBook 使用的语法为 MarkDown，可以使用 Mou 或 GitBook Editor 进行编辑
   SUMMARY.md 示例：

    * [XXX接口文档](README.md)
    * 个人信息
        * [登录](登录.md)
        * [注册](注册.md)
        * [获取验证码](获取验证码.md)
    * 地址管理
        * [地址列表](地址列表.md)
        * [修改地址](修改地址.md)
   

在 XuhaiBook 中新建 xx.md 使用 MarkDown 语法编辑即可

5. 文档生成
   终端 cd 进入 XuhaiBook
   gitbook 生成文档命令:
   gitbook serve
   执行完毕后可以使用提示的 http 地址进行访问，也可以打开 XuhaiBook/_book/index.html 进行查看；
   生成静态网站：
   gitbook build
   如果想要转换成PDF，需先下载安装 calibre 地址：http://calibre-ebook.com/download :
   gitbook pdf
   可以在根目录添加 index.html 文件方便他人查看: