推荐12个实用的gitbook插件

➢ 安装和使用插件方法

在根目录下创建book.json

在该文件中按照指定格式插入以下插件对应的代码。

安装插件有两种方式 :

一种是在book.json写入相应插件和配置后,

使用gitbook install安装插件。

一种是使用npm install pluginName安装,然后写入配置

hide-element 隐藏元素

主要用来隐藏不想看到的元素。

如:

默认的gitbook左侧提示:Published with GitBook

使用方式: book.json中写入以下内容

{
    "plugins": [
        "hide-element"
    ],
    "pluginsConfig": {
        "hide-element": {
            "elements": [".gitbook-link"]
        }
    }
}
back-to-top-button 回到顶部

当文章篇幅较长时,页面底部会显示按钮,一键点击自动回到顶部。

使用方式:

book.json中写入以下内容

{
    "plugins": [
         "back-to-top-button"
    ]
}
chapter-fold 导航目录折叠

gitbook默认目录没有折叠效果。

使用方式: book.json中写入以下内容

{
    "plugins": ["chapter-fold"]
}
code 复制代码

在代码域的右上角添加一个复制按钮,点击一键复制代码。

使用方式:

book.json中写入以下内容

{
    "plugins" : [ "code" ]
}
splitter 侧边栏宽度可调节

左侧目录和右侧文章可以拖动调节宽度。

使用方式:

book.json中写入以下内容

{
    "plugins": [
        "splitter"
    ]
}
search-pro 高级搜索

支持中英文,准确率更高一些。

使用方式:

book.json中写入以下内容

{
    "plugins": [
          "-lunr", 
          "-search", 
          "search-pro"
    ]
}
insert-logo 插入logo

在左侧导航栏上方插入logo

使用方式: book.json中写入以下内容

url支持本地图片也支持网络图片链接

{
    "plugins": [ "insert-logo" ]
    "pluginsConfig": {
      "insert-logo": {
        "url": "images/logo.png",
        "style": "background: none; max-height: 30px; min-height: 30px"
      }
    }
}
custom-favicon 修改标题栏图标

设置浏览器选项卡标题栏的小图标。

使用方式:

book.json中写入以下内容

注意只支持ico后缀的图片,并且只支持本地图片,不支持网络图片链接。

{
    "plugins" : ["custom-favicon"],
    "pluginsConfig" : {
        "favicon": "icon/favicon.ico"
    }
}
pageview-count 阅读量计数

记录每个文章页面被访问的次数。

使用方式:

book.json中写入以下内容

{
  "plugins": [ "pageview-count"]
}
tbfed-pagefooter 页面添加页脚

在每个文章下面标注版权信息和文章时间。

使用方式:

book.json中写入以下内容

{
    "plugins": [
       "tbfed-pagefooter"
    ],
    "pluginsConfig": {
        "tbfed-pagefooter": {
            "copyright":"Copyright &copy dsx2016.com 2019",
            "modify_label": "该文章修订时间:",
            "modify_format": "YYYY-MM-DD HH:mm:ss"
        }
    }
}
popup 弹出大图

点击可以在新窗口展示图片。

使用方式:

book.json中写入以下内容

{
  "plugins": [ "popup" ]
}
sharing-plus 分享当前页面

gitbook默认只有Facebook、Google+、Twiter、Weibo、Instapaper

插件可以有更多分享方式,也可以关闭指定分享方式。

使用方式:

book.json中写入以下内容

{
    "plugins": ["-sharing", "sharing-plus"],
    "pluginsConfig": {
        "sharing": {
             "douban": true,
             "facebook": true,
             "google": true,
             "pocket": true,
             "qq": true,
             "qzone": true,
             "twitter": true,
             "weibo": true,
          "all": [
               "douban", "facebook", "google", "instapaper", "linkedin","twitter", "weibo", 
               "messenger","qq", "qzone","viber","whatsapp"
           ]
       }
    }
}
➢ 综合代码

本文演示代码配置book.json

{
    "plugins": [
        "back-to-top-button",
        "chapter-fold",
        "code",
        "splitter",
        "-lunr",
        "-search",
        "search-pro",
        "insert-logo",
        "custom-favicon",
        "pageview-count",
        "tbfed-pagefooter",
        "popup",
        "-sharing",
        "sharing-plus"
    ],
    "pluginsConfig": {
        "insert-logo": {
            "url": "https://file.smallzhiyun.com/%E4%B9%A6.png",
            "style": "background: none; max-height: 30px; min-height: 30px"
        },
        "favicon": "./icon/book.ico",
        "tbfed-pagefooter": {
            "copyright": "Copyright &copy dsx2016.com 2019",
            "modify_label": "该文章修订时间:",
            "modify_format": "YYYY-MM-DD HH:mm:ss"
        },
        "sharing": {
            "douban": true,
            "facebook": true,
            "google": true,
            "pocket": true,
            "qq": true,
            "qzone": true,
            "twitter": true,
            "weibo": true,
            "all": [
                "douban",
                "facebook",
                "google",
                "instapaper",
                "linkedin",
                "twitter",
                "weibo",
                "messenger",
                "qq",
                "qzone",
                "viber",
                "whatsapp"
            ]
        }
    }
}

安装和使用