使用gitbook构建API文档

安装node.js

1、官网下载安装包：http://nodejs.cn/download/

2、解压到自定义目录:/usr/local/nodejs

3、执行/usr/local/nodejs/bin/node -v

安装gitbook

1、/usr/local/nodejs/bin/npm install -g gitbook

2、/usr/local/nodejs/bin/npm install -g gitbook-cli

3、执行/usr/local/nodejs/bin/gitbook -V

创建自己的gitbook

1、新建目录：wiki

2、在wiki目录下运行：gitbook init

3、编写符合Markdown语法的文档文件，后缀为.md，我比较喜欢用phpstorm写，方便即时预览，通过配置保存即可上传到服务器

 

4、输入地址：localhost:4000（可以在启动时加--port参数指定端口号）预览

5、通过nginx自定义域名，虚拟配置目录添加如下配置:

server {
        listen       80;
        server_name ***;
        access_log ***;
        error_log *** notice;

        location / {
                proxy_pass http://localhost:4000;
                proxy_set_header  Host $host;
                proxy_buffering   off;
        }


}

 

 

MarkDown官方：https://daringfireball.net/projects/markdown/syntax

MarkDown菜鸟：https://daringfireball.net/projects/markdown/syntax

gitbook:http://www.chengweiyang.cn/gitbook/introduction/README.html