GitBook部署Web接口文档

这段时间需要提供API接口服务，要求提供web接口文档，了解对比之后发现gitbook符合要求，支持markdown语法，可以nodejs部署服务，并且支持git版本控制，一拍即合。
Gitbook是基于Nodejs的命令行工具,首先需要安装nodejs环境

第1步 安装nodejs：

• windows版本安装下载地址
• linux通过 yum -y install nodejs 安装好后node -v npm -v查看版本号,能查看到版本号说明nodejs和npm安装OK
  
  安装OK

第2步 npm安装gitbook

• 使用npm安装需要耐心等待,也可以使用淘宝cnpm安装,速度快 npm install -g gitbook-cli

第3步 使用gitbook

• gitbook 的基本用法非常简单：
  cd 到使用目录,使用 gitbook init 初始化书籍目录,会生成两个markdown文件,README.md是文档目录栏的 introduction,SUMMARY.md为目录栏文件

book/
├── README.md
└── SUMMARY.md

0 directories, 2 files

SUMMARY.md

* [Introduction](README.md)
* [****规范与流程](api/api说明.md)
* [****服务](api/api说明.md)
* [****服务](api/api说明.md)
  * [****服务](api/api说明.md)
  * [****服务](api/api说明.md)

• 使用 gitbook serve 编译书籍
  cd 到指定目录,运行gitbook serve命令,就会编译书籍,并且启动web服务,localhost:4000便可以访问
  
  本地访问效果

第4步 服务器部署gitbook文档服务

• 1. linux直接执行gitbook serve 退出ssh命令行窗口时服务会终止

• 2. 后台运行的话需要使用screen,可以使nodejs后台运行
     2.1. 要进行某项操作时，先使用命令创建一个screen
     [linux@user~]$ screen -S gitbook
     2.2. 接着就可以在里面进行操作了，如果你的任务还没完成就要走开的话，使用命令保留Screen：
     [linux@user~]$ Ctrl+a+d 按Ctrl+a，然后再按d即可保留Screen
     [detached]这时会显示出这个提示，说明已经保留好Screen了

     如果你工作完成的话，就直接输入
     [linux@user~]$screen -r gitbook 回到刚才创建的screen
     窗口依然显示

     Starting server ...
     Serving book on http://localhost:4000
     

     此时按 Ctrl+c 终结gitbook服务。

      [linux@user~]$ exit                        #这样就表示成功退出了
      [screen is terminating]
     

• 3.另一种部署方式,直接使用gitbook生成的静态文件,放到tomcat或者nginx供静态访问,执行gitbook serve命令后会生成_book文件夹,里面是生成的html文件,可以直接部署到web容器上

./
├── _book
│   ├── gitbook
│   │   ├── fonts
│   │   ├── gitbook.js
│   │   ├── gitbook-plugin-fontsettings
│   │   ├── gitbook-plugin-highlight
│   │   ├── gitbook-plugin-livereload
│   │   ├── gitbook-plugin-lunr
│   │   ├── gitbook-plugin-search
│   │   ├── gitbook-plugin-sharing
│   │   ├── images
│   ├── index.html
│   └── search_index.json
├── README.md
└── SUMMARY.md