如何快速搭建自己的GitBook
对于编程的爱好者来说,都希望凭自己的经验写一些东西分享给业内别的爱好者和记录一些自己的经验,以防日后忘记,也有历史跟踪。GitBook是一个结合GitHub和Markdown来制作精美在线读物的工具。你可以自己或和任何人合作,编著一本在线书籍,还能够销售,当作家不再只是梦。
资源准备
- Github账号(用户名、邮箱非常重要)注册地址
- 机器安装Node.js 下载最新版本,默认安装
- 机器安装Git,下载最新版本
Hexo安装
npm install -g hexo
注意:如果出现”npm ERR”,则可考虑换成cnpm尝试。
npm install -g cnpm hexo
GitBook安装
npm install -g gitbook-cli //安装gitbook gitbook -V //查看gitbook是否安装成功
GitBook Editor 书的编写工具,可以看到书的目录(可以不用这个写,个人比较喜欢用MarkDownPad来写)
- MarkDownPad
创建项目
- GitHub上面创建一个项目,用来保存每次发布的项目,项目名称Repository name:账户名称.github.io(lkun.github.io)
GitBook使用
根据目录生成图书结构
- 1.1 README.md
readme.md文件相当于一本GitBook的简介。
D:\>mkdir mygitbookTest
D:\test_gitbook>ECHO xxx>README.md
- 1.2 SUMMARY.md
summary.md 是一本书的目录结构.
D:\test_gitbook>ECHO A>SUMMARY.md
输入
# Summary
* [Introduction](README.md)
* [A](a.md)
* [B](b.md)
- 1.3 生成图书结构
当这个目录文件创建好之后,我们可以使用Gitbook
的命令行工具将这个目录结构生成相应的目录及文件:
$ gitbook init
执行完之后,我们发现gitbook给我们生成了与SUMMARY.md所对应的目录及文件。
生成图书
1.1 输出为静态网站
本地预览时自动生成
#执行命令 D:\test_gitbook>gitbook serve
Live reload server started on port: 35729
Press CTRL+C to quit ...
info: 7 plugins are installed
info: loading plugin "livereload"... OK
info: loading plugin "highlight"... OK
info: loading plugin "search"... OK
info: loading plugin "lunr"... OK
info: loading plugin "sharing"... OK
info: loading plugin "fontsettings"... OK
info: loading plugin "theme-default"... OK
info: found 3 pages
info: found 0 asset files
info: >> generation finished with success in 2.7s !
Starting server ...
Serving book on http://localhost:4000
> 然后,浏览器中输入 http://localhost:4000 就可以预览生
成的以网页形式组织的书籍。
这里你会发现,你在你的图书项目的目录中多了一个名为
_book的文件目录,而这个目录中的文件,即是生成的静态
网站内容。
通过build指定路径手动生成
> 你可以将内容输入到你所想要的目录中去: D:\test_gitbook>mkdir temp/gitbook D:\test_gitbook>gitbook build --output=D:\test_gitbook\temp\gitbook
发布书籍
这是最关键的一步了,为了能让自己写好的书在网上能够给别人看到,所以,现在讲上一步build生成的静态网站放在hexo的D:\Books\Hexo\public\2016\08\31目录下,应该也可以放在public的根目录下,还没有试过,比如说你不想放在2016\08\31下,你也可以放在2016\09\10下,这个按照日期来建也是可以的。把文件拷过来了之后,我们就把它push到lkun.github.io这个项目上,然后就可以访问了。
访问路径:https://lkun.github.io/2016/08/31/mygitbooktest/index.html
完毕!