gitbook使用

臭大佬 2020-01-11 00:30:13 1978
工具 
简介 GitBook 是一个基于 Node.js 的命令行工具,支持 Markdown 和 AsciiDoc 两种语法格式,可以输出 HTML、PDF、eBook 等格式的电子书。

说明

GitBook 是一个基于 Node.js 的命令行工具,支持 Markdown 和 AsciiDoc 两种语法格式,可以输出 HTML、PDF、eBook 等格式的电子书。

GitBook 不是 Markdown 编辑工具,也不是 Git 版本管理工具。

但 GitBook 又与 Markdown 和 Git 息息相关,因为只有将它们结合起来使用,才能将它们的威力发挥到极致!因此,通常我们会选择合适的 Markdown 编辑工具以获得飞一般的写作体验;使用 GitBook 管理文档,预览、制作电子书;同时通过 Git 管理书籍内容的变更,并将其托管到云端(比如 GitHub、GitLab、码云,或者是自己搭建的 Git 服务器),实现多人协作。

因此,我推荐,也是我目前使用的搭配是 GitBook + Typora + Git。

安装

详细步骤参考官网,应该被墙了。

需要安装 nodejs,以便能够使用 npm 来安装 gitbook。下载node,点击这里

安装gitbook命令:

npm install -g gitbook-cli

安装成功可以打印版本查看:

gitbook --version

推荐安装 Typora作为gitbook的编辑器(一个很棒的支持 macOS、Windows、Linux 的 Markdown 编辑工具)

Typora 下载地址:https://typora.io/
Git 下载地址:https://git-scm.com/downloads

使用

使用 gitbook init 初始化书籍目录:

gitbook init

README.md —— 书籍的介绍写在这个文件里
SUMMARY.md —— 书籍的目录结构在这里配置

使用Typora编辑这两个文件

可以在SUMMARY.md里面加我们需要的目录大纲

再次执行gitbook init命令,GitBook 会查找 SUMMARY.md 文件中描述的目录和文件,如果没有则会将其创建。

书籍目录结构创建完成以后,就可以使用 gitbook serve 来编译和预览书籍了

 gitbook serve

默认将生成的静态网站输出到 _book 目录。

也可以执行 gitbook build 命令构建书籍

gitbook build [书籍路径] [输出路径]

serve 命令也可以指定端口:

gitbook serve --port 250

生成 PDF 格式的电子书:

gitbook pdf ./../mybook.pdf

生成 epub 格式的电子书:

gitbook epub ./../mybook.epub

生成 mobi 格式的电子书:

gitbook mobi ./../mybook.mobi

附录

关于gitbook更详细的操作可以查看这里:http://www.chengweiyang.cn/gitbook/customize/README.html