GitBook安装与使用

GitBook 准备工作

安装 Node.js

GitBook 是一个基于 Node.js 的命令行工具,下载安装 Node.js,安装完成之后,你可以使用下面的命令来检验是否安装成功。

$ node -v
v7.7.1

安装 GitBook

输入下面的命令来安装 GitBook。

$ npm install gitbook-cli -g

Npm的使用

npm config set registry https://registry.npmjs.org/ # 默认的仓库 

更改仓库地址

npm --registry https://registry.npm.taobao.org/ install express#临时使用
npm config set registry https://registry.npm.taobao.org #永久使用
npm config get registry #检查地址是否设置成功

Gitbook安装完成之后,你可以使用下面的命令来检验是否安装成功。

$ gitbook -V
CLI version: 2.3.2
Installing GitBook 3.2.3
/

等待安装完成后,再次检验

$ gitbook -V
CLI version: 2.3.2
GitBook version: 3.2.3

初始化目录

GitBook 准备工作做好之后,我们进入一个你要写书的目录,输入如下命令。

$ gitbook init
warn: no summary file in this book
info: create README.md
info: create SUMMARY.md
info: initialization is finished

可以看到他会创建 README.md 和 SUMMARY.md 这两个文件,README.md 应该不陌生,就是说明文档,而 SUMMARY.md 其实就是书的章节目录,其默认内容如下所示:

# Summary

* [Introduction](README.md)

接下来,我们输入 $ gitbook serve 命令,然后在浏览器地址栏中输入 http://localhost:4000 便可预览书籍。

导出PDF

在项目的目录中执行

gitbook pdf .

项目目录下就会生成 book.pdf

导出epub

在项目目录中执行

gitbook epub .  

具体的

gitbook epub ./ ./mybook.epub

项目目录下就会生成 mybook.epub

插件管理

GitBook 插件其实也分本地安装和全局安装,本地安装使用 gitbook install 根目录,全局安装使用 npm install gitbook-plugin-name。

默认的插件是

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 

禁用某个插件,创建book.json文件,添加配置文件

"plugins'':{
	"-sharing"
}

插件推荐

info: loading plugin "anchor-navigation-ex"... OK 
info: loading plugin "search-pro"... OK 

search-pro 高级搜索(支持中文)
支持中文搜索, 在使用此插件之前,需要将默认的search和lunr 插件去掉。

anchor-navigation-ex 文章导航
在文章右上角有导航栏

发布了35 篇原创文章 · 获赞 12 · 访问量 6647

猜你喜欢

转载自blog.csdn.net/u012955829/article/details/99098986