《GitBook 编写 API 文档一》安装和使用篇

Tomxin7

打算把“简单校招的”数据整理一下，然后公开部分查询接口，提供给想要自己写程序的同学们使用。公开接口要编写一份接口文档，部门最近很多文档是基于 GitBook，看起来很简单，小清新，所以打算试试。

一、GitBook 简介

GitBook 可不是 git 的说明书，而是一个基于 Node.js 的命令行工具，可使用 Github/Git 和 Markdown 语法 来制作精美的文档或者电子书。GitBook 可以直接生产 HTML 站点，也可以单独部署，很方便。

二、软件安装

1、环境要求

你需要先安装：node.js，具体安装方法网上很多教程

2、通过 NPM 安装

$ npm install -g gitbook-cli

3、检测安装是否成功：

$ gitbook -V
CLI version: 2.3.2
GitBook version: 3.2.3

3、编辑器安装

官方网站：https://legacy.gitbook.com

要是不想麻烦，或者网速不佳，可以直接从我上传的百度云下载
链接：https://pan.baidu.com/s/1jS9TaeQfu4nmHC_BXHZmTA 提取码：ptq3 

三、GitBook 的使用

方式 1、gitbook 命令初始化

gitbook init

可以查看到，生成了相应的两个文档，一个是概述文档，一个 readme 文档。

方式 2、GitBook Editor 初始化

直接跳过登录




新建文档



可以开始愉快的编辑了

四、生成和部署

1、如果你是通过第二种方式初始化文档的话，文档会保存在

C:\Users\***\GitBook\Library\Import

2、在根目录下执行

gitbook serve

3、项目启动后，可以访问 http://localhost:4000

info: 7 plugins are installed
info: loading plugin "livereload"... OK
info: loading plugin "highlight"... OK
info: loading plugin "search"... OK
info: loading plugin "lunr"... OK
info: loading plugin "sharing"... OK
info: loading plugin "fontsettings"... OK
info: loading plugin "theme-default"... OK
info: found 1 pages
info: found 0 asset files
info: >> generation finished with success in 0.5s !

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

4、我们需要的静态网页存在_book 文件夹中，但是这样拿去部署会有链接无法跳转的问题，我们需要做一些修改

1、找到目录下的theme.js文件
2、将if(m)改成if(false)，由于代码是压缩后的，会没有空格，搜索的时候可以直接搜索： if(m)for(n.handler&&

5、这样就大功告成了，可以直接部署到服务器上