GitBook常用插件

2024-01-26 20:10:40

GitBook常用插件

GitBook全局设置
GitBook常见插件
book.json 全部代码

GitBook全局设置

学习借鉴明月,博客中的内容，在自己使用后进行整理以下内容。

title 标题

设置书本的标题。
在book.json中加入以下内容：

{
    "title" : "Ruarua"
}

author 作者

作者的相关信息。
在book.json中加入以下内容：

{
    "author" : "ycc"
}

description 描述

本书的简单描述。
在book.json中加入以下内容：

{
    "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
例如，配置使用简体中文,在book.json中加入以下内容：

{
    "language" : "zh-hans"
}

GitBook常见插件

添加GitBook常见插件首先要在项目目录文件夹下添加book.json文件，然后在book.json中输入对应内容，并在项目目录下控制台输入gitbook install即可安装。

toggle-chapters 折叠目录

默认只在目录导航中显示章的标题，而不会显示小节的标题，点击每一章或者每一节会显示当前章或节的子目录，如果有的话，但是同时会收起其它之前展开的章节。
在book.json中加入以下内容：

{
    "plugins": ["toggle-chapters"]
}

hide-element 隐藏元素

可以用来隐藏不想看到的元素，例如隐藏GitBook默认提示：~~Published with GitBook~~ ，在book.json中加入以下内容：

{
  "plugins": [
    "hide-element"
  ],
  "pluginsConfig": {
	"hide-element": {
		"elements": [".gitbook-link"]
	}
  }
}

tbfed-pagefooter 添加页脚

在每个文章下面标注版权信息和文章时间。
在book.json中加入以下内容：

{
  "plugins": [
    "tbfed-pagefooter"
  ],
  "pluginsConfig": {
	"tbfed-pagefooter": {
		"copyright": "Copyright &copy ruarua 2020",
		"modify_label": "该文章修订时间：",
		"modify_format": "YYYY-MM-DD",
	}
  }
}

sharing-plus 分享页面

GitBook默认只有Facebook、Google+、Twiter、Weibo、Instapaper，插件可以有更多分享方式，也可关闭指定分享方式。
在book.json中加入以下内容：

{
  "plugins": [
    "-sharing","sharing-plus"
  ],
  "pluginsConfig": {
	"sharing": {
		  "facebook": "false",
		  "google": "false",
	      "twiter": "false",
		  "qq": "true",
		"all": [
			"facebook","google","twiter","qq"
		]
	}
  }
}

search-pro 高级搜索

搜索支持中英文，准确率更高。
在book.json中加入以下内容：

{
  "plugins": [
    "-lunr","-search","search-pro"
  ]
}

insert-logo 插入logo

在左侧导航栏上方插入logo。
在book.json中加入以下内容：

{
  "plugins": [
    "insert-logo"
  ],
  "pluginsConfig": {
	"insert-logo": {
		"url": "../assets/logo.png",
		"style": "background: none"
	}
  }
}

custom-favicon 修改标题栏图标

设置浏览器选项卡标题栏的小图标。
在book.json中加入以下内容：

{
  "plugins": [
    "custom-favicon"
  ],
  "pluginsConfig": {
	"favicon": "assets/favicon.ico"
	}
  }
}

book.json 全部代码

{
  "title" : "Ruarua",
  "author" : "ycc",
  "description" : "记录Gitbook的配置和一些插件的使用",
  "language" : "zh-hans",
  "plugins": [
	"toggle-chapters",
	"insert-logo",
	"-sharing",
	"hide-element",
	"tbfed-pagefooter",
	"-lunr",
	"-search",
	"search-pro",
	"custom-favicon"
  ],
  "pluginsConfig": {
    "tbfed-pagefooter": {
		"copyright": "Copyright &copy ruarua 2020",
		"modify_label": "该文章修订时间：",
		"modify_format": "YYYY-MM-DD"
	},
	"hide-element": {
		"elements": [".gitbook-link"]
	},
	"insert-logo": {
		"url": "../assets/logo.jpg",
		"style": "background: none"
	},
	"favicon": "assets/favicon.ico"
  }
}

码农公寓