如何用gitbook写文档并存到github上

Posted 2023-05-06

1. 安装npm，从网站 下载node.js源代码 https://nodejs.org/#download 

解压
./configure
make
make install

成功执行后，npm就被安装好了。

2. gitbook 安装

npm install -g gitbook-cli
gitbook -V

查看gitbook是否安装成功。

3 安装git

https://code.google.com/p/msysgit/downloads/list

4 生成sshkey

输入 ssh-keygen ，按enter，一直按enter 公钥生成在 C:\\Documents and Settings\\xxx\\.ssh 目录中，找到目录 ，里面有id_rsa.pub文件，用记事本打开，然后把里面的东西 全选复制。

并在github上配置sshkey

5 下载gitbookeditor并安装

 https://www.gitbook.com/editor/windows

6 github上新建一个项目

[e-mail]:zimingforever/mygitbook.git

并把这个项目直接clone到gitbook的文件目录下面C:\\Users\\XXX\\GitBook\\Library\\Import\\mygitbook

初始化文件夹

echo # mygitbook >> README.md
git initgit add README.md
git commit -m "first commit"
git remote add origin [e-mail]:zimingforever/mygitbook.git
git push -u origin master

7 打开gitbookeitor，FILE-》imoport 找到之前的clone的文件

左侧table of contents可以增加新的章节或者文章

8 gitbook editor打开后，book-editor confugration可以设置book.json文件

9 目录 book-repo setting可以设置远程的git地址，需要更改成http的地址https://github.com/zimingforever/mygitbook.git，然后设置对应的账号及密码

10 每次gitbook eidtor编辑完之后可以点击下右侧的sync按钮，相关的文件就会推到github上

11 使用gitbook命令生成对应的html文件

c:

cd C:\\Users\\xxx\\GitBook\\Library\\Import\\

gitbook build mygitbook

12 将生成好的html文件推到github上

c:

cd C:\\Users\\xxx\\GitBook\\Library\\Import\\mygitbook

git config --global credential.helper store

git add -A

git commit -m \'udpatebook\'

git push

start https://github.com/zimingforever/mygitbook/tree/master/_book

13 GITBOOK editor的使用界面

14 使用githubpage来打开对应的地址

http://htmlpreview.github.io/

15 生成地址为 http://htmlpreview.github.io/?https://github.com/zimingforever/mygitbook/blob/master/_book/index.html 直接访问即可

参考技术A word文档另存为.mht文件
打开的时候用word打开速度比较快 如果用ie就比较慢.
还可以编译成为.chm帮助文档 需要特殊工具 这个打开速度 文件大小等等都非常棒 就是初次制作可能难点

文档工具GitBook使用

一、登陆注册

地址：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了。