1. Gitbook 插件使用
- 方法
-
1.1. 方法
1.1.1. 配置
在
book.json
中的plugins
中配置需要安装的插件,例如安装自定义的网站图标的插件favicon
,则可以在插件属性配置pluginsConfig
中将自己的logo
图标设置为网站的图标:{ "plugins": [ "favicon" ], "pluginsConfig": { "favicon": { "shortcut": "assets/images/favicon.ico", "bookmark": "assets/images/favicon.ico", } }
1.1.2. 安装
在
plugins
配置完所需插件之后,在book.json
所在的根目录下,输入命令行gitbook install
或
使用
NPM
安装npm install gitbook-plugin-插件名
进行安装
1.1.3. 使用
例如安装完 alerts 插件之后,可以将块引用转换为漂亮的提示格式的信息。使用方式为 在markdown文档中:
> **[warning]** 不要忘记将`“IMODEL_ID”`占位符值替换为现有的 `iModel ID`,将`“HOSTNAME”`占位符值替换为已部署的应用程序主机名
则页面显示为:
[warning] 不要忘记将
“IMODEL_ID”
占位符值替换为现有的iModel ID
,将“HOSTNAME”
占位符值替换为已部署的应用程序主机名
1.2. 可用插件
- insert-logo - 插入logo
- favicon - 更改网站图标
- search-pro - 高级搜索 (支持中文)
- splitter - 侧边栏宽度可调节
- sharing-plus - 分享当前页面
- code - 代码添加行号 & 复制按钮
- expandable-chapters-small - 折叠侧边栏
- alerts - 漂亮格式的提示块
- hide-elements - 隐藏元素
- anchor-navigation-ex - 悬浮目录和回到顶部