gitbook插件

1. 默认插件

Gitbook默认带有7个插件&＃xff08;功能性5个&＃xff0c;搜索有两个&＃xff0c;主题一个&＃xff09;&＃xff1a;

• livereload 热加载插件
• highlight 语法高亮插件
• search 搜索插件
• lunr 搜索插件后台服务
• sharing 分享插件
• fontsettings 字体设置插件
• theme-default 主题

2. 添加和移除插件

在 book.json 中的 plugins 模块能够配置&＃xff0c;能够使 Gitbook 的功能更丰富。

在 plugins 中添加对应的插件名称

"plugins": ["highlight","-search","back-to-top-button","expandable-chapters-small","insert-logo"
]


其中"-search"中的 - 符号代表去除默认自带的插件

3. 插件配置pluginsConfig

部分插件在引入后需要进行详细的配置&＃xff0c;可以在 pluginsConfig 中加配置说明。

"pluginsConfig": {"insert-logo": {"url": "images/logo.png","style": "background: none; max-height: 30px; min-height: 30px"}
}


4. 插件安装

4.1 方法一

插件无需单独下载安装&＃xff0c;只有在 book.json 中配置好对应的插件&＃xff0c;执行 gitbook install, 缺少的插件就会自动下载安装

gitbook install .


4.2 方法二

自定义的插件也可以通过 npm 或者将解压后的包复制到 node_modules 目录中进行安装。

npm install gitbook-plugin-xxx


4.3 方法三

也可以从源码GitHub地址中下载&＃xff0c;放到 node_modules 文件夹里&＃xff08;GitHub地址在进入插件地址右侧的GitHub链接&＃xff09;.

5. 插件预览