2019独角兽企业重金招聘Python工程师标准>>>
GitBook
安装
GItBook官网
GitBook文档
个人推荐编辑器下载
安装 node.js
gitbook 是基于 Node.js的命令行工具,下载地址
检测是否安装成功:
$ node -v
10.14.2
安装 GitBook
$ npm install -g gitbook-cli
检测是否安装成功:
$ gitbook -V (大写的V)
CLI version: 2.3.2
GitBook version: 3.2.3
其他命令 请参考: gitbook help
及 gitbook --help
卸载 npm uninstall -g gitbook
创建书籍
$ gitbook init bookname --log=debug
warn: no summary file in this book
info: create README.md
info: create SUMMARY.md
info: initialization is finished
配置文件 book.json
在书籍目录 bookname
中,新建一个 book.json
文件,可以配置网站信息、加载的插件等相关内容。事例如下:
GitBook插件下载地址
{"title": "标题","description": "描述...","author": "Mr.Zhang","generator": "GitBook","language": "zh-hans","direction": "ltr","plugins": ["-sharing","-search","-lunr","expandable-chapters-small"],"pluginsConfig": {},"styles": {"website": "styles/style.css","ebook": "styles/ebook.css","pdf": "styles/pdf.css","mobi": "styles/mobi.css","epub": "styles/epub.css"},"structure": {"readme": "README.md"},"links": {"gitbook": false}
}
说明:
- plugins: 配置插件,
-
表示去掉此插件 - styles: 定义自己的样式文件
- ....
安装插件
$ npm install xxx
或 在 book.json 中 plugins 添加好相关插件后,执行
$ gitbook install
默认插件
- highlight 语法高亮插件
- search 搜索框插件
- sharing 分享插件
- fontsettings 字体插件
- livereload 动态加载插件,主要在
gitbook serve
时进行修改文件,自动加载时使用
如果需要去除自带插件,可如下配置:
"plugins": ["-sharing","-search","-lunr","expandable-chapters-small"
],
生成书籍
生成网站
$ gitbook build <bookpath>
生成预览
$ gitbook serve .
默认是4000端口
生成pdf
$ gitbook pdf <bookpath>
生成pdf时,需要Calicre依赖,下载地址及安装
其他生成命令请参考 gitbook 帮助