GitBook使用教程

1.环境安装

1.1 nodejs安装

大家可根据自己的操作系统下载对应的版本，本教程仅介绍windows系统下的nodejs安装，其它系统类似。nodejs官方下载地址：https://nodejs.org/zh-cn/

为了避免安装过程中出现未知错误，建议不要使用高版本的nodejs，本教程使用的版本为12.16.2，并不影响使用，
安装到指定位置，一直下一步即可，没有踩坑点。

打开cmd命令提示符，执行如下命令，验证是否安装成功

C:\Users\Administrator>node -v
v12.16.2

以上输出代表安装成功，否则会提示不是内部或外部命令

1.2 安装GitBook库

命令提示符中执行如下命令：

C:\Users\Administrator>npm install gitbook-cli -g

执行如下命令，验证是否安装成功

C:\Users\Administrator>gitbook -V
CLI version: 2.3.2
GitBook version: 3.2.3

注意V是大写

1.3 安装ebook-convert以及calibre

为了支持GitBook的导出功能，需要安装ebook-convert和calibre

1.3.1 安装ebook-convert

命令提示符中执行如下命令：

C:\Users\Administrator>npm install ebook-convert -g

执行如下命令验证ebook-convert是否安装成功

C:\Users\Administrator>ebook-convert --version
ebook-convert.exe (calibre 6.7.1)
Created by: Kovid Goyal <[email protected]>

1.3.2 安装calibre

下载对应系统的安装包，官网下载地址：https://calibre-ebook.com/download

本人安装的是6.7.1版本，安装之后会自动把安装根目录加入到环境变量path中，如果大家用的低版本，务必确认安装根目录是否已经加入到环境变量path中。

2 GitBook使用

2.1 创建简单的GitBook

首先在指定位置为自己的电子书创建目录，并进入到该目录中

E:\>mkdir my-gitbook
E:\>cd my-gitbook

执行gitbook init命令，初始化电子书目录，执行完后会自动创建目录文件SUMMARY.md和README.md文件

E:\my-gitbook>gitbook init
warn: no summary file in this book
info: create README.md
info: create SUMMARY.md
info: initialization is finished

执行gitbook serve启动web服务，默认端口4000。

E:\my-gitbook>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 1 pages
info: found 0 asset files
info: >> generation finished with success in 0.4s !

Starting server ...
Serving book on http://localhost:4000

浏览器地址栏输入http://localhost:4000 ，访问该电子书

2.2 GitBook基本使用

2.2.1 多级目录

实现多级目录，只需要修改根目录的summary.md文件即可
示例如下：

bui# Summary

* [介 绍](README.md)
* [第 1 章：后端学习之路](Elysia-BE/README.md)
* [第 2 章：前端学习之路](Elysia-FE/README.md)
	* [2.1 开发工具](Elysia-FE/dev-tools/README.md)
		* [2.1.1 GitBook](Elysia-FE/dev-tools/gitbook.md)
* [第 3 章：优秀项目学习](Elysia-Projects/README.md)
* [第 4 章：好用工具分享](Elysia-Tools/README.md)

其中章节通过缩进进行约束，末尾的链接是相对电子书对应的文件夹的根目录
修改后登录localhost:4000查看效果如下：

2.2.2 目录折叠

在根目录创建book.json文件，内容如下

{
    "plugins": [ 
        "expandable-chapters"
    ]
}

请手动执行gitbook install安装刚才引入的插件

E:\GitBook\Elysia>gitbook  install
info: installing 1 plugins using [email protected]
info:
info: installing plugin "expandable-chapters"
info: install plugin "expandable-chapters" (*) from NPM with version 0.2.0
E:\GitBook\Elysia
`-- [email protected]

info: >> plugin "expandable-chapters" installed with success

从新执行gitbook serve命令，发现目录已经可以折叠了，效果如下

2.2.3 分隔符

只需要在md文件中使用---即可将内容分隔开，直接上例子，例如某个md文中内容如下

* [第 1 章：GitBook](/Elysia-FE/dev-tools/gitbook.md)
* [第 2 章：GitBook](/Elysia-FE/dev-tools/gitbook.md)
* [第 3 章：GitBook](/Elysia-FE/dev-tools/gitbook.md)
---
* [第 4 章：GitBook](/Elysia-FE/dev-tools/gitbook.md)
* [第 5 章：GitBook](/Elysia-FE/dev-tools/gitbook.md)
* [第 6 章：GitBook](/Elysia-FE/dev-tools/gitbook.md)
---
* [第 7 章：GitBook](/Elysia-FE/dev-tools/gitbook.md)
* [第 8 章：GitBook](/Elysia-FE/dev-tools/gitbook.md)
* [第 9 章：GitBook](/Elysia-FE/dev-tools/gitbook.md)

效果如下

不仅可以将功能相关的功能导航放在一起，同时使内容看上去不那么臃肿。

2.2.4 友情链接

在book.json中增加links属性

book.json文件中记得用英文逗号,跟其它属性分割

{
    "links": {
        "sidebar": {
            "本书github站点": "https://github.com/chenguo-design/Elysia"
        }
    }
}

效果如下图：

2.2.5 设置书名、作者、描述、语言等

在book.json中添加如下内容

{
    "title": "《Elysia》",
    "author": "ChenGuo",
    "description": "记录学习、工作期间学习到的知识，见证自己的成长

标签：info,gitbook,教程,md,plugin,插件,GitBook,使用	

From： https://www.cnblogs.com/elysia-shine/p/16824906.html