GitBook 入门使用教程

小渣渣

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

安装node.js

在使用gitbook工具之前，电脑需要安装node.js环境，装好以后，可以通过查看版本命令来测试是否安装成功：

登录可见。

安装Gitbook

Gitbook 是用 npm 安装的，命令行：

登录可见。

执行下面的命令，查看 GitBook 版本，以验证安装成功。

登录可见。

安装历史版本

gitbook-cli 可以轻松下载并安装其他版本的GitBook来测试您的书籍：

登录可见。

使用 gitbook ls-remote 会列举可以下载的版本。


Markdown编辑器

这里我们使用Markdown语法作为我们的文档的书写语言，我们需要准备一个Markdown编辑器，市面上我们可以找到很多 Markdown 编辑器，比如 Typora、MacDown、Bear、MarkdownPad、MarkdownX、JetBrains’s IDE（需要安装插件）、Atom、简书、CSDN 以及 GitBook 自家的 GitBook Editor 等等。

我电脑中装有vs code开发工具，vs code默认是支持markdown的，只需要装一个预览插件神器：Markdown Preview Enhanced，所有就使用它了！



朋友推荐的编辑器typora，地址：超链接登录可见。

初始化一本书

GitBook可以设置一个样板书：

登录可见。

如果您希望将书籍创建到一个新目录中，可以通过运行 gitbook init ./directory 这样做。

执行完后，你会看到多了两个文件 —— README.md 和 SUMMARY.md，它们的作用如下：

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

我对markdown语法也不熟，就随便写几句话吧！

登录可见。

生成静态网页

登录可见。

生成静态网页并运行服务器

登录可见。

以上都会在书籍目录生成 _book。


serve 命令也可以指定端口：

登录可见。

生成时指定gitbook的版本, 本地没有会先下载

登录可见。

列出本地所有的gitbook版本

登录可见。

列出远程可用的gitbook版本

登录可见。

安装对应的gitbook版本

登录可见。

更新到gitbook的最新版本

登录可见。

卸载对应的gitbook版本

登录可见。

指定log的级别

登录可见。

输出错误信息

登录可见。

Summary

GitBook 使用 SUMMARY.md 文件来定义本书的章节和子章节的结构。 SUMMARY.md 文件用于生成本书的目录。

SUMMARY.md 的格式是一个链接列表。链接的标题将作为章节的标题，链接的目标是该章节文件的路径。

向父章节添加嵌套列表将创建子章节。

简单示例：

登录可见。

然后我们回到命令行，在 mybook 文件夹中再次执行 gitbook init 命令。GitBook 会查找 SUMMARY.md 文件中描述的目录和文件，如果没有则会将其创建。

输出 PDF、ePub或者mobi文件

如果要生成pdf版本，则运行gitbook pdf即可，同理，如果是导出epub格式，则gitbook epub，如果是mobi格式，则gitbook mobi即可。

登录可见。

如果是要导出PDF，ePub或者mobi格式的电子书时，需要安装Calibre电子书阅读/管理器和命令行工具，不然可能会报错“EbookError: Error during ebook generation: 'ebook-convert'”。

GitBook 特殊文件的功能：

文件	描述
book.json	配置数据 (optional)
README.md	电子书的前言或简介 (required)
SUMMARY.md	电子书目录 (optional)
GLOSSARY.md	词汇/注释术语列表 (optional)

Gitbook 常规设置

GitBook 允许您使用灵活的配置自定义您的电子书。

这些选项在 book.json 文件中指定。对于不熟悉 JSON 语法的作者，您可以使用 JSONlint 等工具验证语法。

变量	描述
root	包含所有图书文件的根文件夹的路径，除了 book.json
structure	指定自述文件，摘要，词汇表等的路径
title	您的书名，默认值是从 README 中提取出来的。在 GitBook.com 上，这个字段是预填的。
descrip{过滤}tion	您的书籍的描述，默认值是从 README 中提取出来的。在 GitBook.com 上，这个字段是预填的。
author	作者名。在GitBook.com上，这个字段是预填的。
isbn	国际标准书号 ISBN
language	本书的语言类型 —— ISO code 。默认值是 en
direction	文本阅读顺序。可以是 rtl （从右向左）或 ltr （从左向右），默认值依赖于 language 的值。
gitbook	应该使用的GitBook版本。使用SemVer规范，并接受类似于 “> = 3.0.0” 的条件。