介绍
在我们认识Gitbook之前,应当先熟悉对Git的使用,Git是目前比较好的分布式版本控制系统(当然还有svn)。
Git不仅是程序员管理代码的工具,它的分布式协作同样适用很多场景,其中之一就是写作,因此Gitbook呼之欲出。
Gitbook是一个基于Node.js的命令行工具,支持Markdown和AsciiDoc两种语法,可以输出HTML、PDF、eBook等格式。因此使用Gitbook需要Markdown编辑工具,市面上的Markdown比较多,我这里推荐使用Gitbook自家的Gitbook Editor。
因此,Gitbook + Git + Markdown来管理、预览、制作电子文档,同时通过Git管理内容变更,并将其托管到云端(如:码云、GitHub),实现多人协作。
特性
语法简单
兼容性强
导出方便
专注内容
团队协作
安装
首先需要安装Node.js(当然还需安装git命令)
下载地址:https://nodejs.org/en/download/
找对应的平台,下载安装即可。
npm install -g gitbook-cli
安装完后,就会多一个Gitbook命令(如果没有,请确认加了-g)
其次安装Markdown编辑工具Gitbook Editor
下载地址:https://legacy.gitbook.com/editor
使用
mkdir test # 新建一个空目录
cd test/
gitbook init # 初始化文档,这个一步可以使用Gitbook Editor直接打开test空目录
执行完成后,目录下会多两个文件README.md 和 SUMMARY.md
README.md # 文档的介绍
SUMMARY.md # 文档目录结构
编辑SUMMARY.md,如下:
# Summary
* [前言](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)
然后回到test目录,在次执行gitbook init,GitBook 会查找 SUMMARY.md 文件中描述的目录和文件,如果没有则会将其创建。
访问
$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 8 pages
info: found 7543 asset files
info: >> generation finished with success in 15.8s !
Starting server ...
Serving book on http://localhost:4000
浏览器访问:http://localhost:4000,如下图:
发布
gitbook build
默认会生成静态文件,输出到_book目录下。
其他
gitbook build 文档路径 输出路径
gitbook serve --port 1234 # 指定端口启动
gitbook pdf ./ ./test.pdf # 生成PDF文档
gitbook epub ./ ./test.epub # 生成epub文档
gitbook mobi ./ ./test.nobi # 生成mobi文档