合 gitbook插件整理--book.json文件配置
- 1.1. 全局配置
- 1.2. 插件列表 PLUGINS
- 1.3. 插件属性配置PLUGINSCONFIG
- 2.1. BACK-TO-TOP-BUTTON 回到顶部
- 2.2. 导航目录折叠
- 2.2.1. CHAPTER-FOLD 左侧目录折叠
- 2.2.2. EXPANDABLE-CHAPTERS-SMALL 左侧章节目录可折叠
- 2.2.3. EXPANDABLE-CHAPTERS 可扩展导航章节
- 2.3. 代码复制,行号
- 2.3.1. CODE 代码添加行号&复制按钮(可选)
- 2.3.2. COPY-CODE-BUTTON 代码块复制按钮
- 2.4. TODO 待做项☑
- 2.12. 页脚、版权信息
- 2.12.1. TBFED-PAGEFOOTER 页面添加页脚(内容少)
- 2.12.2. PAGE-COPYRIGHT 页面页脚版权(内容多)
- 2.13. SECTIONX 将页面分块显示
- 2.14. 生成页内目录
- 2.14.1. PAGE-TREEVIEW 生成页内目录
- 2.14.2. SIMPLE-PAGE-TOC 生成本页目录
- 2.15. 悬浮目录
- 2.15.1. PAGE-TOC-BUTTON 悬浮目录
- 2.15.2. ANCRE-NAVIGATION 悬浮目录和回到顶部
- 2.16. KLIPSE 嵌入类似IDE的功能
- 2.19. 警报
- 2.19.1. ALERTS 警报
- 2.19. FLEXIBLE-ALERTS 警报
- 2.20. PAGEVIEW-COUNT 阅读量计数
- 2.21. AUTO-SCROLL-TABLE 表格滚动条
- 2.22. 查看图片
- 2.22.1. POPUP 弹出大图
- 2.22. LIGHTBOX 单击查看图片
- 2.23. CLICK-REVEAL 点击显示
- 2.24. CUSTOM-FAVICON 修改标题栏图标
- 2.25. ACCORDION 折叠模块
- 2.26. HIDE-ELEMENT 隐藏元素
- 参考
1. 配置概况
1.1. 全局配置
- title
设置书本的标题"title" : "Gitbook Use"
- author
作者的相关信息"author" : "mingyue"
- description
本书的简单描述"description" : "记录Gitbook的配置和一些插件的使用"
- language
Gitbook使用的语言, 版本2.6.4中可选的语言如下:en, ar, bn, cs, de, en, es, fa, fi, fr, he, it, ja, ko, no, pl, pt, ro, ru, sv, uk, vi, zh-hans, zh-tw
例如,配置使用简体中文"language" : "zh-hans"
- links
在左侧导航栏添加链接信息12345"links" : {"sidebar" : {"Home" : "https://www.baidu.com"}} - styles
自定义页面样式, 默认情况下各generator对应的css文件1234567"styles": {"website": "styles/website.css","ebook": "styles/ebook.css","pdf": "styles/pdf.css","mobi": "styles/mobi.css","epub": "styles/epub.css"}例如使
<h1> <h2>
标签有下边框, 可以在website.css
中设置123h1 , h2{border-bottom: 1px solid #EFEAEA;}1.2. 插件列表 PLUGINS
配置使用的插件
123456"plugins": ["-search","back-to-top-button","expandable-chapters-small","insert-logo"]其中
"-search"
中的-
符号代表去除默认自带的插件
Gitbook默认自带有5个插件:- highlight: 代码高亮
- search: 导航栏查询功能(不支持中文)
- sharing:右上角分享功能
- font-settings:字体设置(最上方的"A"符号)
- livereload:为GitBook实时重新加载
1.3. 插件属性配置PLUGINSCONFIG
配置插件的属性
例如配置insert-logo
的属性:123456"pluginsConfig": {"insert-logo": {"url": "images/logo.png","style": "background: none; max-height: 30px; min-height: 30px"}}2. 一些实用插件
记录一些实用的插件
用法:在book.json中添加以下内容。然后执行gitbook install
,或者使用NPM安装(单独安装推荐NPM)npm install gitbook-plugin-插件名
,也可以从源码GitHub地址中下载,放到node_modules
文件夹里(GitHub地址在进入插件地址右侧的GitHub链接)2.1. BACK-TO-TOP-BUTTON 回到顶部
插件地址
GitHub地址
在book.json中添加以下内容。然后执行gitbook install
,或者使用NPM安装(单独安装推荐NPM)npm install gitbook-plugin-back-to-top-button
,也可以从源码GitHub地址中下载,放到node_modules
文件夹里(GitHub地址在进入插件地址右侧的GitHub链接)12345{"plugins": ["back-to-top-button"]}2.2. 导航目录折叠
2.2.1. CHAPTER-FOLD 左侧目录折叠
支持多层目录,点击导航栏的标题名就可以实现折叠扩展。
插件地址
GitHub地址
在book.json中添加以下内容。然后执行gitbook install
,或者使用NPM安装(单独安装推荐NPM)npm install gitbook-plugin-chapter-fold
,也可以从源码GitHub地址中下载,放到node_modules
文件夹里(GitHub地址在进入插件地址右侧的GitHub链接)123{"plugins": ["chapter-fold"]}2.2.2. EXPANDABLE-CHAPTERS-SMALL 左侧章节目录可折叠
支持多层目录,比Toggle Chapters好用
只有点击箭头才能实现折叠扩展。不如【2.2.1. chapter-fold 左侧目录折叠】好用
插件地址
GitHub地址
在book.json中添加以下内容。然后执行gitbook install
,或者使用NPM安装(单独安装推荐NPM)npm install gitbook-plugin-expandable-chapters-small
,也可以从源码GitHub地址中下载,放到node_modules
文件夹里(GitHub地址在进入插件地址右侧的GitHub链接)12345{"plugins": ["expandable-chapters-small"]}2.2.3. EXPANDABLE-CHAPTERS 可扩展导航章节
和expandable-chapters-small效果相同,唯一不同的是这个插件的箭头粗
插件地址
GitHub地址
在book.json中添加以下内容。然后执行gitbook install
,或者使用NPM安装(单独安装推荐NPM)npm install gitbook-plugin-expandable-chapters
,也可以从源码GitHub地址中下载,放到node_modules
文件夹里(GitHub地址在进入插件地址右侧的GitHub链接)12345{"plugins": ["expandable-chapters"]}2.3. 代码复制,行号
2.3.1. CODE 代码添加行号&复制按钮(可选)
为代码块添加行号和复制按钮,复制按钮可关闭
单行代码无行号。
插件地址
GitHub地址
在book.json中添加以下内容,然后执行gitbook install
,或者使用NPM安装(单独安装推荐NPM)npm install gitbook-plugin-code
,也可以从源码GitHub地址中下载,放到node_modules
文件夹里(GitHub地址在进入插件地址右侧的GitHub链接)123{"plugins" : [ "code" ]}本人提供Oracle(OCP、OCM)、MySQL(OCP)、PostgreSQL(PGCA、PGCE、PGCM)等数据库的培训和考证业务,私聊QQ646634621或微信db_bao,谢谢!