GitBook 是一个基于 Node.js 的命令行工具,支持 Markdown 和 AsciiDoc 两种语法格式,可以输出 HTML、PDF、eBook 等格式的电子书。
因为支持markdown所以书写起来很舒服而且结合各种插件以及git一起使用,可以快速,舒适的打造一个属于自己的在线电子书网站。
搭建gitbook首先要安装node环境
安装好node后,使用node -v
命令查看是否安装成功
接着全局安装gitbook-cli
npm install -g gitbook-cli
安装成功后,就会多了一个 gitbook
命令(如果没有,请确认上面的命令是否加了 -g
)。
接着在电脑中找一个心仪的目录,创建一个文件夹,在文件夹下执行命令
gitbook init
执行完成后,目录中会多两个文件 README.md 和 SUMMARY.md
作用分别是
- README.md —— 书籍的简介
- SUMMARY.md —— 书籍的目录
SUMMARY.md的配置方法
# 目录
* [前言](README.md)
* [章节名称](相对路径)
* [第1节](相对路径)
* [第2节](相对路径)
* [第3节](相对路径)
* [第4节](相对路径)
* [第二章](相对路径)
* [第三章](相对路径)
书写完书籍内容,配置好目录以后,在命令行中,再次执行命令
gitbook init
重新生成一下目录和文件
然后执行命令
gitbook serve --port [指定端口默认4000]
启动服务,预览书籍,执行命令后会对 Markdown 格式的文档进行转换,默认转换为 html 格式,最后提示 Serving book on [http://localhost:4000](http://localhost:4000/)
代表服务启动完成,在浏览器访问即可预览
如果当前书籍写完了,想要发布到自己的网站的话,也可以使用命令输出成html文件使用
gitbook build [书籍路径] [输出路径]
最后搭配git一起使用时,只需要在书籍根目录下执行
git init
创建一个git仓库,然后就愉快的拉取-书写-提交
循环即可了。
别忘了在提交的时候忽略掉module文件夹,不然每次提交拉取的时候会很痛苦....
网友评论