GitBook 使用

介绍

GitBook是一个基于Node.js的命令行工具，可以使用 Github/Git和Markdown来制做精美的电子书，GitBook 并不是关 Git的教程。

导出格式有PDF、HTML等，须要添加相应插件。

官网：https://www.gitbook.com

---

安装

安装npm

从网站 https://nodejs.org/en/download/ 上下载并安装

npm -v

查看是否安装成功。

安装gitbook

npm install -g gitbook-cli

gitbook -V

查看是否安装成功。

安装GitBook Editor

这是官方的一个客户端编辑器。能够不安装，直接在GitBook网站上编辑文档也是能够的。

下载地址：https://www.gitbook.com/editor

如今的版本是7.0.12，若是要切换到Markdown编辑器，右下角有个按钮，点击而后选择“Edit Markdown”便可使用Markdown编辑器。若是是旧的版本，

---

使用

直接使用

在页面上，直接点击“+New Book”，根据提示便可建立一本书，而后就能够进行编辑了。

可用editor编辑，也能够网站上直接编辑。

关联GitHub

GitHub：先在上GitHub建立一个仓库。

GitBook：而后在GitBook右上角的我的信息那里，点击“Account Settings”，在界面上选择“GitHub”这个Tab，找到“Integration”选项卡，有一个按钮“Install GitHub integration on this account”，点击，选择刚刚在GitHub建立的仓库便可。

注意：后续若是还须要继续作关联，在GitHub网站的Setting中的“Intalled GitHub Apps”，对GitBook进行配置便可。

GitBook：建立一个新书，而后点击setting，有一个GitHub选项卡，选择关联的GitHub仓库便可。

如今就可用editor编辑，也能够网站上直接编辑，还能够用GitHub进行管理了。

---

文件结构

除了README.md，还须要SUMMARY.md这个文件，这个是书的结构，以下：

# Summary
* 第一章
    * [第一节](di-yi-zhang/di-yi-jie.md)
    * [第二节](di-yi-zhang/di-er-jie.md)
* 第二章
* 第三章

文件夹“di-yi-zhang”跟SUMMARY.md都在根目录。

默认状况下，若是是直接在网页上编辑的，目录跟文件名都会是拼音，固然能够本身命名。

---

导出

导出HTML，会在_book文件夹下生成文件

gitbook build

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

导出PDF

gitbook pdf

---

其余功能

https://chrisniael.gitbooks.io/gitbook-documentation/content/index.html

插件搜索地址：https://plugins.gitbook.com/