背景

近期想要自己沉淀,而且也有意学习下如何贡献自己的知识,给更多人分享我的所得,所以就萌生自己写一个系列的入门书。
本次主要通过GitHub上面来进行源码托管,通过GitBook来进行排版及线上阅读下载等,利用Markdown语法来进行撰写。所以最好有一些GitHub及Markdown使用经验最嘉。

作案工具准备

很简单:

  1. GitHub帐号
  2. GitBook帐号(可利用GitHub帐号登录,也可申请)

GitHub配置

新建一个repo,比如hwangjr/simple-android,ignore可以选择git book,READ ME等自己可以配置。

GitBook配置

新建一本书籍简易Android

将代码托管到GitHub上

点击Settings,选择右侧GitHub,会让你先与你的GitHub帐号进行关联(如果还未进行关联的话),然后设置成你在GitHub上新建的项目即可,即hwangjr/simple-android。

绑定自定义域名

你可以绑定自己的自定义域名来进行解析到你的书籍。
1.在GitBook上设置你的域名。
点击右侧的Domains设置,即/settings/domains,然后输入你的HomePage及content的domain,这边设置为:
For homepage: simple-android.hwangjr.com
For content: content.simple-android.hwangjr.com

2.在域名解析商那边进行解析配置。
这里主要以万网解析进行配置,其他配置可参考,大同小异。
新增两条解析规则:
CNAME simple-android 默认 www.gitbook.com
CNAME content.simple-android 默认 www.gitbook.com
这里需要注意,记录值需要设置为www.gitbook.com,不能设置为gitbook.com等其他。
绑定完可以测试下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
nslookup simple-android.hwangjr.com
Server:		192.168.1.1
Address:	192.168.1.1#53

Non-authoritative answer:
simple-android.hwangjr.com	canonical name = www.gitbook.com.
www.gitbook.com	canonical name = saga-4658.herokussl.com.
saga-4658.herokussl.com	canonical name = elb049689-1604000308.us-east-1.elb.amazonaws.com.
Name:	elb049689-1604000308.us-east-1.elb.amazonaws.com
Address: 54.83.21.67
Name:	elb049689-1604000308.us-east-1.elb.amazonaws.com
Address: 54.243.203.15
Name:	elb049689-1604000308.us-east-1.elb.amazonaws.com
Address: 54.197.223.43

具体也可参考:Custom Domains

GitBook软件安装

首先需要Node.js环境,才能安装GitBook软件。简单说明下软件安装。
安装Node.js最好用creationix/nvm来进行版本管理。

1
2
3
4
curl https://raw.github.com/creationix/nvm/master/install.sh | sh
nvm install 0.12
nvm use 0.12
npm install gitbook -g

NPM较慢可以参考:淘宝 NPM 镜像
之后即可用git book在本地进行书籍调试。

Markdown配置

Markdown目前一般用stackedit.io进行编写,之后进行同步~也有很多其他的软件,类似MarkdownPad等,都可以进行本地编写,VIM也有相应的Markdown插件。