文档工具GitBook使用

Posted 2020-10-03

一、登陆注册

地址：https://www.gitbook.com/

1、gitbook可使用github账号登录，如果已经注册github可以直接使用github账号登录

2、如果是github账号登录，在登录成功后，点击右上角的头像，选择‘account setting’去设置用户Email信息

 

 

 

二、创建文档

 

1、点击右上角的‘+New’创建新的BOOk， Public表示所有人可看，Private表示指定人可看

 

2、创建完成后，可以开始写文档，或者点击Settings->Collaborators邀请其他人一起来完善文档

 

 

三、windows客户端

因gitbook服务器在国外，在线写文档速度会比较慢，使用客户端进行编写，速度相对会快一些

客户端地址：http://download.csdn.net/detail/qq_16417155/9594632

使用gitbook账号登录后，可以同步在线的Book进行编写，写完后通Sysn同步到gitbook

 

四、生成HTML

同样的原因，因gitbook站点在国外，阅读起来会比较慢，可以通过生成html部署到自有网站，加快显示速度

参考：

 

http://www.colobu.com/2014/10/09/gitbook-quickstart/

注：安装HTML工具前，请先安装nodejs

安装HTML生成工具:

1. 进入cmd

2. 执行：npm install gitbook -g

3. 执行：npm install -g gitbook-cli

生成HTML：

安装完生成工具之后，执行以下命令进行生成.

gitbook build 所在目录

比如我的book所在目录是 D:\hongw\Import\docs

那么执行 gitbook build D:\hongw\Import\docs

执行完成后，目录下的_book里就有我们整本书的Html了。