安装插件
插件是 GitBook 拓展功能的主要机制。GitBook 插件本质上和 Node.js 包一样,因此其安装也分为全局和本地,全局安装命令: $ npm install -g plugin_name -g --save
。本地安装则可以使用 GitBook 自带的命令 $ gitbook install
完成, 其将自动安装 book.json
中所配置的插件,不需要任何参数,默认的安装目录是文档目录下的 ./node_modules/
目录。因此建议将该目录加入 .gitignore
的忽略列表中。
GitBook 文档推荐插件的命名方式为:
gitbook-plugin-X: 插件
gitbook-theme-X: 主题
1. 在 book.json
文件中添加插件名称
GitBook 在编译书籍的时候会读取书籍源码顶层目录中的 book.js
或者 book.json
,参考 GitBook 文档。
book.json
文件中,plugins
选项用来添加、关闭插件,如下面的内容表示关闭 sharing
插件,使用 sharing-plus
插件:
"plugins": ["-sharing", "sharing-plus"],
GitBook 默认带有5个插件:highlight
、search
、sharing
、fontsettings
、livereload
更多插件可从 https://plugins.gitbook.com/ 或者 https://www.npmjs.com/ 搜索。
2. 安装插件
执行下面的命令,GitBook 会自动安装所需插件:
gitbook install
3. 设置插件配置
一般而言,插件都有默认配置,如果需要的话,在 book.json
中加入插件配置内容即可。例如:
"pluginsConfig": {
"sharing": {
"douban": false,
"facebook": false,
"google": false,
"hatenaBookmark": false,
"instapaper": false,
"line": false,
"linkedin": false,
"messenger": false,
"pocket": false,
"qq": true,
"qzone": true,
"stumbleupon": false,
"twitter": false,
"viber": false,
"vk": false,
"weibo": true,
"whatsapp": false,
"all": [
"facebook", "google", "twitter",
"weibo", "qq", "linkedin",
"qzone", "douban"
]
}
}