新版gitbook+github+Typora使用方法

前言

gitbook在2018年4月9日发布了新的版本v2。新的版本官网已经变成 www.gitbook.com ,旧的平台地址为 legacy.gitbook.com ,已经不能再新注册了,并且新旧平台的数据都不互通。最大的区别是旧版是把每本书作为一个 Git Repository 来进行版本管理,是book的概念;但是新版则升级为 Orgnization,然后再在这个 Orgnization 里面创建一个 Space(旧版叫 Book)。

个人还是喜欢旧版的排版方式。但旧版已经不能再注册了。同时gitbook editor也是不能登陆了,这一点让我纠结了很久,后来才发现是新旧版本的问题,才有了这个教程。

此教程是使用typora来编写markdown,所见所得,非常方便;然后再使用git将写的文章推送到github上,最后在gitbook上面设置关联,这样就完成了。

全部软件下载位置:https://pan.8994.cn:5001/sharing/uWeIGwijE ,密码: git

安装gitbook命令

因为 GitBook 是基于 Node.js,所以我们首先需要安装 Node.js(下载地址:https://nodejs.org/en/download/ ),找到对应平台的版本安装即可。安装完成之后,需要重启电脑,之后再运行npm install -g gitbook-cli

1
2
3
4
5
6
7
8
C:\Users\fdm>npm install -g gitbook-cli
C:\Users\fdm\AppData\Roaming\npm\gitbook -> C:\Users\fdm\AppData\Roaming\npm\node_modules\gitbook-cli\bin\gitbook.js
+ gitbook-cli@2.3.2
added 578 packages from 672 contributors in 45.615s

C:\Users\fdm>gitbook -V
CLI version: 2.3.2
GitBook version: 3.2.3

再使用gitbook -V来查看是否有正常安装成功了。

初始化gitbook

首先cmd到一个目录下面,运行gitbook init来初始化文件,默认会生成2个文件,README.md 书籍的介绍写在这个文件里;SUMMARY.md书籍的目录结构在这里配置。

1
2
3
4
5
D:\book>gitbook init
warn: no summary file in this book
info: create README.md
info: create SUMMARY.md
info: initialization is finished

然后在SUMMARY.md上面输入以下内容:

1
2
3
4
5
6
7
8
9
* [前言](README.md)
* [第一章](Chapter1/README.md)
* [第1节:衣](Chapter1/衣.md)
* [第2节:食](Chapter1/食.md)
* [第3节:住](Chapter1/住.md)
* [第4节:行](Chapter1/行.md)
* [第二章](Chapter2/README.md)
* [第三章](Chapter3/README.md)
* [第四章](Chapter4/README.md)

再继续一次gitbook init,这时可以看到,gitbook就自动生成了这些目录了。再运行gitbook serve来预览这本书籍,执行命令后会对 Markdown 格式的文档进行转换,默认转换为 html 格式,最后提示 “Serving book on http://localhost:4000 “嗯,打开浏览器看一下吧:


可以看到,可以正常输出内容来了。但上图显示的是旧版的book排版,看上去会简结很多,而新版就不是这样了,这边要有疯狂吐槽中。。。

安装git以及相关操作

登陆github之后,新建一个仓库,如下:

这时会出现一些指令,提示是第一次新建仓库需要做的事情,这边先忽略,不按这个来做。

1
2
3
4
5
6
echo "# book" >> README.md
git init
git add README.md
git commit -m "first commit"
git remote add origin https://github.com/fang141x/book.git
git push -u origin master

上传代码

  1. 安装工具

上传代码之前,要先安装2个工具,打开https://git-scm.com/downloads下载git工具,打开https://tortoisegit.org/download/下载TortoiseGit以及简介中文包,依次安装即可。

  1. 配置软件

安装完成之后,打开Git Bash,运行ssh-keygen -t rsa -C "your_email@youremail.com",后面的your_email@youremail.com改为你在github上注册的邮箱,之后会要求确认路径和输入密码,我们这使用默认的一路回车就行。

成功的话会在~/下生成.ssh文件夹,如我的目录是C:\Users\fdm\ .ssh,打开id_rsa.pub,复制里面的key(可以把这个公钥文件删除,只保留id_rsa私钥文件)。

回到github上,进入 Account Settings(账户配置),左边选择SSH Keys,Add SSH Key,title随便填,粘贴在你电脑上生成的key。

使用ssh -T git@github.com验证是否成功的方法:

配置username和email,github每次commit都会需要这2个参数

1
2
git config --global user.name "name"
git config --global user.email "mail"

  1. 上传代码

进入d:\book,右键选择 “Git 在这边创建版本库”,


确定之后,再大右键选择,提交到masster上,选择全部,输入message之后,提交:

提交到本地的master库之后,需要推送到github,还是右键选择TortoiseGit,推送,再点击管理,在url输入github仓库的链接,如下:


然后在远端输入master,表示推送到远端的master主库上,如下图是成功的标记:

另外一个方法是,打开Git Bash,运行以下指令即可:

1
2
git remote add origin https://github.com/fang141x/book.git
git push -u origin maste

这样就把代码上传到github了,以后有更新文件,只需要按上述方法操作一下即可。

gitbook

首先注册一下。

进入后台,首先创建一下组织,再创建一下空间,再选择sync with github

再选择刚刚创建的book,然后一路next即可。

githook还能配置自己的域名,设置好了之后的效果如下:

安装Typora

打开https://www.typora.io/下载即可。为什么要选择这款软件来写markdown呢?我个人认为只有一个,可以很方便的截图。如下是设置方法:

总结

一套完整的流程走下来,显而易见,需要安装的软件很多,但是还是很值得的,因为这样就设置好了,以后往github推送的文件会自动推送到gitbook,可以做到实时更新。

是时候放弃有道云笔记了~!

参考资料

0%