- 安装gitbook
安装gitbook
$ npm install gitbook-cli -g验证安装版本
$ gitbook -V CLI version: 2.3.2 GitBook version: 3.2.3
- 使用('markdown语法')
创建文件夹工作区并初始化
$ mkdir 文件夹名 & cd 文件夹名 #默认文件夹名作为书名 $ gitbook init #在文件夹目录下执行初始化命令完成后自动生成的目录结构
SUMMARY.md书目录结构,默认的介绍连接为README.md,网站侧栏的目录。
README.md介绍文章编写文章,并在
SUMMARY.md添加连接构建
$gitbook build # 可选参数: 书路径 输出路径,生成, 生成电子书需要安装 转换软件,并添加环境变量。
网页本地预览,启动成功后使用浏览器访问 ``
$ gitbook serve # 可选参数: --port 本机电脑端口生成pdf电子书
$ gitbook pdf # 可选参数 书路径 输出文件路径生成epub电子书
$ gitbook epub # 可选参数 书路径 输出文件路径生成mobi电子书
$ gitbook mobi # 可选参数 书路径 输出文件路径
- 插件安装方法
- 方法一 (速度慢)
- 在书目录新建 book.json, 添加需要安装的插件
{ "plugins":[ "-lunr", "-search", "search-pro", "expandable-chapters", "chapter-fold", "splitter", "anchor-navigation-ex", "back-to-top-button", "prism","-highlight", "tbfed-pagefooter" ], "pluginsConfig": { "prism": { } } } - 执行
gitbook install
- 在书目录新建 book.json, 添加需要安装的插件
- 方法二
$ npm install gitbook-plugin-插件名 - 方法三
npm init初始化一个package.json- 在package.json中
dependencies添加插件 - 使用
npm install安装插件
- 方法一 (速度慢)
- 常用插件
- 搜索search-pro,
- 兼容性,需要
gitbook >= 3.0.0 support, - 插件安装排除冲突
"-lunr", "-search", "search-pro"
- 兼容性,需要
- 左侧可折叠菜单栏chapter-fold
- 插件安装
"chapter-fold" - 插件配置
"chapter-fold":{}
- 插件安装
- 左侧可折叠菜单栏2expandable-chapters
- 插件安装
"expandable-chapters" - 插件配置
"expandable-chapters":{}
- 插件安装
- 可调节侧栏宽度splitter
- 插件安装
"splitter"
- 插件安装
- 页面内目录page-treeview
- 插件安装
"page-treeview" - 插件配置
"page-treeview": { "copyright": "Copyright © aleen42", "minHeaderCount": "2", "minHeaderDeep": "2" }
- 插件安装
- 悬浮按钮目录anchor-navigation-ex
- 插件安装
"anchor-navigation-ex"
- 插件安装
- 回到顶部back-to-top-button
- 插件安装
"back-to-top-button"
- 插件安装
- 数学公式支持mathjax-pro
- 插件安装
"mathjax-pro" - 插件配置
"mathjax-pro":{ "version": "2.7.5" }
- 插件安装
- 流程图flowchart
- 插件安装
"flowchart" - 插件配置
"flowchart": { "line-color": "red" }
- 插件安装
- 搜索search-pro,
- 其他内容