必看说明

GitBook 简单配置使用请参考 链接

  • plugins 是配置新增或删除插件的位置,而 Gitbook 默认自带有 5 个插件:

    sharing:右上角分享功能

    font-settings:字体设置(左上方的"A"符号)

    livereload:为 GitBook 实时重新加载

    highlight: 代码高亮

    search: 导航栏查询功能(不支持中文)

  • pluginsConfig 是插件配置的地方

特别说明 系统自带插件可通过 在插件名前面加减号的方式去除掉,如-sharing

再添加了插件后要加载使用插件,需要使用gitbook install 来安装进项目。否则无法使用。

tips:网络环境不好的小伙伴可能需要等待很长时间,可能都还安装不下来。

不要灰心,可以使用 npm install gitbook-plugin-插件名的方式进行安装。若这种方式也很慢

则配置下 npm 源吧

npm config set registry=http://registry.npm.taobao.org -g

参考本人完整配置详情:

{
"author": "Levy",
"description": "This is record sharing by Levy.",
"extension": null,
"generator": "site",
"isbn": "",
"links": {
"sharing": {
"all": null,
"facebook": null,
"google": null,
"twitter": null,
"weibo": null
},
"sidebar": {
"谷歌": "https://www.google.com"
}
},
"output": null,
"pdf": {
"fontSize": 12,
"footerTemplate": null,
"headerTemplate": null,
"margin": {
"bottom": 36,
"left": 62,
"right": 62,
"top": 36
},
"pageNumbers": true,
"paperSize": "a4"
},
"plugins": ["page-treeview", "code", "pageview-count", "popup", "tbfed-pagefooter", "favicon",
"search-plus", "expandable-chapters", "hide-element", "back-to-top-button", "splitter",
"-lunr", "-search", "-sharing", "sharing-plus", "chapter-fold"],
"pluginsConfig": {
"hide-element": {
"elements": [".gitbook-link"]
},
"tbfed-pagefooter": {
"copyright": "Copyright levywang123@gmail.com 2020",
"modify_label": "该文章修订时间:",
"modify_format": "YYYY-MM-DD HH:mm:ss"
},
"favicon": {
"shortcut": "assets/favicon.ico",
"bookmark": "assets/favicon.ico",
"appleTouch": "assets/favicon.ico",
"appleTouchMore": {
"120x120": "assets/favicon.ico",
"180x180": "assets/favicon.ico"
}
},
"fontsettings": {
"theme": "white",
"family": "sans",
"size": 2
},
"page-treeview": {
"copyright": "Copyright levywang123@gmail.com 2020",
"minHeaderCount": "2",
"minHeaderDeep": "2"
},
"sharing": {
"all": ["facebook", "google", "linkedin", "twitter", "weibo", "qq"]
}
},
"language": "zh-hans",
"title": "Levy",
"variables": {},
"styles": {
"website": "assets/styles/website.css"
}
}

插件说明

page-treeview 目录

GitHub 地址

不需要在文档中插入标签,能够支持到 6 级目录,安装即可用。

这个插件生成目录以后,下面有一行关于版权的文字。

这行文字可以通过样式来进行控制,让它不显示出来。

.treeview__container {
margin-bottom: 0px !important;
}
.treeview__container-title {
display: none !important;
}

code 代码

GitHub 地址

为代码块添加行号和复制按钮,复制按钮可关闭

单行代码无行号。

"code": {
"copyButtons": false
}

pageview-count 阅读量计数

该插件用来统计当前页面被访问次数

popup 图片点击查看

GitHub 地址

插件用于点击图片时,打开新的网页用来查看高清大图。

tbfed-pagefooter 页面添加页脚(简单版)

GitHub 地址

在每个页面的最下方自动添加页脚信息,配置如下:

"tbfed-pagefooter": {
"copyright": "Copyright levywang123@gmail.com 2020",
"modify_label": "该文章修订时间:",
"modify_format": "YYYY-MM-DD HH:mm:ss"
},

page-copyright 页面添加页脚(复杂版)

GitHub 地址

在每个页面的最下方自动添加页脚配置的各个信息,配置如下:

 "page-copyright": {
"description": "footer",
"copyright": "Copyright levywang123@gmail.com 2020",
"timeColor": "#ccc",
"copyrightColor": "#ddd",
"utcOffset": "8",
"style": "normal",
"noPowered": false,
"signature": "levy",
"wisdom": "footer",
"format": "YYYY-MM-dd hh:mm:ss",
},

favicon 修改图标

修改网页标题的图标,显示个性化 ico

        "favicon": {
"shortcut": "assets/favicon.ico",
"bookmark": "assets/favicon.ico",
"appleTouch": "assets/favicon.ico",
"appleTouchMore": {
"120x120": "assets/favicon.ico",
"180x180": "assets/favicon.ico"
}
},

search-plus 替换原搜索插件

原搜索插件不支持中文搜索,所以使用该插件进行替换。需要将原插件进行去除掉。

    "plugins": [ "search-plus", "-lunr", "-search"]

expandable-chapters 及 chapter-fold 导航目录

两个插件配合使用,使导航目录使用更正常,以免出现导航栏问题。

一个支持多层目录,一个是在目录前方加上箭头。使点击两个都有效。

hide-element 隐藏界面元素

GitHub 地址

可以隐藏不想看到的元素,比如导航栏中 下方的 Published by GitBook

"elements": [".gitbook-link"]

back-to-top-button 返回顶部

GitHub 地址

在页面篇幅过长时,在界面右下角自动添加上返回顶部的按钮。

splitter 侧边栏宽度调整

GitHub 地址

添加完插件后,在界面上 侧边栏可自行调整宽度。

sharing-plus 分享插件

插件地址

需要将自带的插件给隐藏掉 -sharing

分享当前页面,比默认的 sharing 插件多了一些分享方式。

"sharing": {
"douban": false,
"facebook": false,
"google": false,
"pocket": false,
"qq": false,
"qzone": false,
"twitter": false,
"weibo": false,
"all": [
"qq", "qzone","viber","whatsapp",
"douban", "facebook", "google", "instapaper", "linkedin",
"messenger","twitter", "weibo"
]
}

donate 打赏插件

配置打赏模块,在每篇文章底部都会加上一个按钮,点击显示图片

"donate": {
"wechat": "/assets/img/donate/wechat.png",
"alipay": "/assets/img/donate/alipay.png",
"title": "",
"button": "赏",
"alipayText": "支付宝打赏",
"wechatText": "微信打赏"
}

GitBook 常用插件的更多相关文章

  1. 前端构建工具之gulp_常用插件

    gulp常用插件的使用 今天来看看一下gulp的常用插件的使用 就像gruntjs需要一个Gruntfile.js文件一样,gulp也需要一个文件作为它的主文件,在gulp中这个文件叫做gulpfil ...

  2. Jenkins常用插件说明(持续更新)

    本文主要记录在学习以及使用Jenkins过程中常用的对我们有帮助的插件,同时本文将会持续进行更新.如果大家发现有其他野很好用的插件,也欢迎参照下面的格式,在评论中进行回复反馈. 一.通用插件 1.Em ...

  3. Maven常用插件

    maven利用各种插件来管理构建项目,本文记录下工作中常用到的插件及使用方法.每个插件都会提供多个目标(goal),用于标示任务.各插件配置在pom.xml里,如下: <build> [. ...

  4. Struts2 JQuery UI常用插件

    一.什么是插件 ①是遵循一定接口规范编写的程序 ②是原有系统平台功能的扩展和补充 ③只能运行在规定的系统平台下,而不能单独运行 注:由于jQuery插件是基于jQuery脚本库的扩展,所以所有jQue ...

  5. Easy UI常用插件使用

    一.easy UI是类似于jQuery UI的插件库,它提供了丰富的各种常用插件:tree.datagrid... tree插件: 语法:$(selector).tree([settings]); 常 ...

  6. AngularJS常用插件与指令收集

    angularjs 组件列表 bindonce UI-Router Angular Tree angular-ngSanitize模块-$sanitize服务详解 使用 AngularJS 开发一个大 ...

  7. jQuery常用插件

    jQuery UI插件简介: jQuery UI是以 jQuery 为基础的开源 JavaScript 网页用户界面代码库.包含底层用户交互.动画.特效和可更换主题的可视控件.我们可以直接用它来构建具 ...

  8. Sublime 常用插件简介

    Sublime   常用插件简介 emmet: 前端必备神器.花个十几分钟学下Emmet语法 ,就可以极大提高web开发者HTML和CSS工作效率啦.一句话,牛逼---必备 CSS3: CSS3语法高 ...

  9. maven常用插件pom配置

    一.问题描述: 部署一个maven打包项目时,jar包,依赖lib包全部手动上传至服务器,然后用maven部署报错:Exception in thread "main" java. ...

随机推荐

  1. Django坑_02

    在创建订单的时候会创建一个对应的日期 查询数据库表的时候,查询年的话可以正常实现 但是如果单独查询某一个月的话,可能会出错 在 Django 中月份可能会使用 Django 中定义的时区 将 项目 s ...

  2. 完了!TCP出了大事!

    前情回顾:<非中间人就不能劫持TCP了吗?> 不速之客 夜黑风高,乌云蔽月. 两位不速之客,身着黑衣,一高一矮,潜入Linux帝国. 这一潜就是一个多月,直到他们收到了一条消息······ ...

  3. 如何部署redis服务

    使用工具 redis-64-3.2.100 部署系统 windows server 2012R2 1.下载安装redis-64-3.2.100安装包,下载地址:https://github.com/m ...

  4. Python File tell() 方法

    概述 tell() 方法返回文件的当前位置,即文件指针当前位置.高佣联盟 www.cgewang.com 语法 tell() 方法语法如下: fileObject.tell() 参数 无 返回值 返回 ...

  5. CF R 632 div2 1333D Challenges in school №41

    LINK:Challenges in school №41 考试的时候读错题了+代码UB了 所以wa到自闭 然后放弃治疗. 赛后发现UB的原因是 scanf读int类型的时候 宏定义里面是lld的类型 ...

  6. day8.列表、字典、集合相关操作

    一.列表的相关操作 # (1)列表的拼接 (同元组) # (2)列表的重复 (同元组) # (3)列表的切片 (同元组) # 语法 => 列表[::] 完整格式:[开始索引:结束索引:间隔值] ...

  7. 动态绑定CheckBoxList,并默认勾选多选框

    首先这是界面展示列: 当我点击更新操作后,效果如下: 其中所属区域的复选框为动态绑定,并且已为我们默认勾选了相关选项,具体操作如下: 前台代码: <tr> <td class=&qu ...

  8. Springboot+Mybatis+Clickhouse+jsp 搭建单体应用项目(三)(添加增删改查)

    一.添加增加接口 @ApiResponses(value = { @ApiResponse(code = 200, message = "接口返回成功状态"), @ApiRespo ...

  9. 如何利用Python在网上接单,兼职也能月薪过万

  10. Mac 系统更新怎么忽略

    1.在“终端”命令行中输入以下命令: sudo softwareupdate --ignore “macOS Catalina” 2.按回车键,然后输入管理员密码*,然后再次按回车键,以超级用户权限执 ...