正文

gitbook实用配置及插件介绍(代码片段)

zhangjk1993  zhangjk1993  2022-12-02  393

关键词：

配置

title

设置书本的标题

"title" : "Gitbook Use"

author

作者的相关信息

"author" : "zhangjikai"

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

在左侧导航栏添加链接信息

"links" : 
    "sidebar" : 
        "Home" : "http://zhangjikai.com"

styles

自定义页面样式，默认情况下各generator对应的css文件

"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中设置

h1 , h2
    border-bottom: 1px solid #EFEAEA;

plugins

配置使用的插件

"plugins": [
    "disqus"
]

添加新插件之间需要运行gitbook install来安装新的插件

Gitbook默认带有5个插件：
* highlight
* search
* sharing
* font-settings
* livereload

如果要去除自带的插件，可以在插件名称前面加-

"plugins": [
    "-search"
]

pluginsConfig

配置插件的属性

"pluginsConfig": 
    "fontsettings": 
        "theme": "sepia",
        "family": "serif",
        "size":  1

插件

记录一些实用的插件

Disqus

添加disqus评论

插件地址

"plugins": [
    "disqus"
],
"pluginsConfig": 
    "disqus": 
        "shortName": "gitbookuse"

Search Pro

支持中文搜索, 需要将默认的search插件去掉, 注意: 如果标题中有包含的关键字, 标题的样式会有所变化
插件地址

"plugins": [
    "-search",
    "search-pro"
],
"pluginsConfig": 
    "search-pro": 
        "cutWordLib": "nodejieba",
        "defineWord" : ["Gitbook Use"]

Advanced Emoji

支持emoji表情
emoij表情列表
 插件地址

"plugins": [
    "advanced-emoji"
]

使用示例

Github

添加github图标
插件地址

"plugins": [ 
    "github" 
],
"pluginsConfig": 
    "github": 
        "url": "https://github.com/zhangjikai"

Ace Plugin

使gitbook支持ace
插件地址

"plugins": [
    "ace"
]

使用示例

Emphasize

为文字加上底色
插件地址

"plugins": [
    "emphasize"
]

使用示例

KaTex

为了支持数学公式, 我们可以使用KaTex和MathJax插件, 官网上说Katex速度要快于MathJax
插件地址
 MathJax使用LaTeX语法编写数学公式教程

"plugins": [
    "katex"
]

使用示例

Include Codeblock

使用代码块的格式显示所包含文件的内容. 该文件必须存在.
插件地址

"plugins": [
    "include-codeblock"
]

使用示例

Splitter

使侧边栏的宽度可以自由调节

插件地址

"plugins": [
    "splitter"
]

Mermaid

支持渲染Mermaid图表
插件地址

"plugins": [
    "mermaid"
]

使用示例

分享当前页面, gitbook的默认插件, 使用下面方式来禁用

 plugins: ["-sharing"]

配置:

"pluginsConfig": 
    "sharing": 
        "weibo": true,
        "facebook": true,
        "twitter": true,
        "google": false,
        "instapaper": false,
        "vk": false,
        "all": [
            "facebook", "google", "twitter",
                "weibo", "instapaper"
        ]

Tbfed-pagefooter

为页面添加页脚
插件地址

"plugins": [
   "tbfed-pagefooter"
],
"pluginsConfig": 
    "tbfed-pagefooter": 
        "copyright":"Copyright &copy zhangjikai.com 2015",
        "modify_label": "该文件修订时间：",
        "modify_format": "YYYY-MM-DD HH:mm:ss"

Toggle Chapters

是左侧的章节目录可以折叠
插件地址

"plugins": ["toggle-chapters"]

Sectionx

将页面分块显示
插件地址

"plugins": [
   "sectionx"
]

使用示例

Codeblock-filename

为代码块添加文件名称
插件地址

plugins: [ "codeblock-filename" ]

使用示例

ga

google 统计
插件地址

"plugins": [
    "ga"
 ],
"pluginsConfig": 
    "ga": 
        "token": "UA-XXXX-Y"

baidu

百度统计
插件地址

"plugin": [
    "baidu"
 ],
"pluginsConfig": 
    "baidu": 
        "token": "YOUR TOKEN"

在线演示

实际效果可以查看这里
 github地址

gitbook入门教程之插件介绍(代码片段)

插件是gitbook的扩展功能,很多炫酷有用的功能都是通过插件完成的,其中插件有官方插件和第三方插件之分.推荐官方插件市场https://plugins.gitbook.com/寻找或下载相应的插件.当然也可以去npm市场搜索gitbook插件,根据gitbook插件规范,gitbo... 查看详情

gitbook安装教程(代码片段)

...录前言介绍一、nodejs安装配置1.1安装1.2镜像配置二、本地gitbook安装配置2.1切换到D盘2.2安装gitbook-cli2.3查看版本2.4初始化gitbook2.5启动gitbook前言介绍GitBook是一款现代化的文档平台，这个工具链(GitBook)是一个使用Git和Markdown来构... 查看详情

gulp介绍及常用插件使用方法(代码片段)

...。它不仅能对资源进行优化，而且在开发过程中能够通过配置自动完成很多重复的任务，让我们可以专注于代码，提高工作效率。一、API介绍gulp常用的API只有四个：gulp.task(),gulp.src(),gulp.dest(),gulp.watch() 1.gulp.src()输出（Emits）... 查看详情

jenkins——持续集成介绍及jenkins安装部署（插件+用户权限+凭据+maven打包）(代码片段)

...要素持续集成的好处Jenkins介绍Jenkins安装和持续集成环境配置持续集成流程说明Gitlab代码托管服务器安装Gitlab添加组、创建用户、创建项目源代码上传至Gitlab服务器Jenkins服务器安装Jenkins服务器安装Jenkins插件管理Jenkins用户权查看详情

gitbookeditor的相关介绍及与git、gitbook的区别

参考技术A 咋一看GitBook的名字，你可能会认为它是关于Git的一本书。而当你有所了解之后，你也许会认为它是一个使用Git构建电子书的工具。其实不然，GitBook与Git的关系，就像雷锋塔和雷锋那... 查看详情

vscode常用插件及配置(代码片段)

VScode常用插件及配置一、常用插件BracketPairColorizerC/C++Chinese(Simplified)LanguagePackforVisualStudioCodeDeviceTreeGuidesOneDarkProvscode-iconskoroFileHeader二、常用配置"window.zoomLevel":0,"editor 查看详情

实用的按键原理及应用(代码片段)

关注+星标公众号，不错过精彩内容转自 |嵌入式大杂烩按键在电子产品中很常见，今天给大家分享一套按键库源码及应用。https://gitee.com/zhengnianli/EmbedSummaryFlexibleButton介绍FlexibleButton是一个基于标准C语言的小巧灵活的... 查看详情

gitbook入门教程之网站域名备案icp插件(代码片段)

欢迎访问gitbook-plugin-icp官网??用于在首页页脚区域添加icp网站备案信息的Gitbook插件??主页Github:https://snowdreams1006.github.io/gitbook-plugin-icp/GitLab:https://snowdreams1006.gitlab.io/gitbook-plugin-icp/Gitee:https://snowdreams1006.gitee.io/gitbook-plugin-icp/屏幕截... 查看详情

nginx实用插件(代码片段)

前言本篇文章会从一些nginx上实用的插件进行介绍，以及应对后端服务出现故障处理、高并发限流、黑白名单插件、Nginx第三方插件的应用。这里包括爬虫限流、以及恶意请求，这些常见的场景下的处理。代理服务故障处... 查看详情

简单实用的jenkins部署及操作(代码片段)

JenkinsJenkins是开源CI&CD软件领导者，提供超过1000个插件来支持构建、部署、自动化，满足任何项目的需要。案例1.官方文档：https://www.jenkins.io/zh/doc/下载jenkiins:https://mirrors.tuna.tsinghua.edu.cn/jenkins/redhat/jenkins-2.2 查看详情

web前端之vue的插件下载指令及介绍npminstallsave(代码片段)

目录1、菜单导航、递归插件1、菜单导航、递归插件1、下载命令npminstallmj-menu--save2、参数介绍参数描述是否必须mjMenuTree数据源trueselectCallback菜单激活的回调falseopenCallbacksub-menu展开的回调falsecloseCallbacksub-menu收起的回调false3、局... 查看详情

vim插键及配置(代码片段)

...你觉得这个页面广告太多，欢迎移步博客阅读：Vim插键及配置编辑器之神——Vim平日使用vim经常编辑文件，想想使用时的痛点，决定研究一下插件的使用。Vim的扩展通常也被成为bundle或插件。软件版本：MacOSX10.14.1vim8.1插件安装-V... 查看详情

用markdown写博客及markdown介绍(代码片段)

...大家挑用的顺手的就行，都大同小异有道云笔记印象笔记gitbook以上几款均有查看详情

jenkins——jenkins介绍+基于云平台的jenkins安装和持续集成环境配置（插件+用户权限+凭据+maven打包）(代码片段)

...—Jenkins介绍+基于云平台的Jenkins安装和持续集成环境配置（插件+用户权限+凭据+Maven打包）持续集成及Jenkins介绍软件开发生命周期什么是持续集成？持续集成的组成要素持续集成的好处Jenkins介绍Jenkins安装... 查看详情

简单实用的tomcat集群搭建技法及排错(代码片段)

目录简介一、Tomcat集群配置二、zabbix监控Tomcat1.配置tomcat服务器2.配置zabbix服务器3.zabbix管理网页添加监控Tomcat简介Tomcat集群的主要特性：负载均衡：把任务均衡地分布到集群环境下的节点服务器，在并发访问量大的环... 查看详情

maven变量及常见插件配置详解(代码片段)

...义变量及内置变量1.自定义变量2.内置变量二、常见插件配置1.编译插件2.设置资源文件的编码方式3.自动拷贝jar包到target目录4.生成源代码jar包5.将项目打成jar包一、变量-自定义变量及内置变量1.自定义变量<properties><project.b... 查看详情

002.ansible部署及配置介绍(代码片段)

一Ansible的安装部署1.1PIP方式安装PIP略，可参考《001.Pip简介及使用》。提示：建议将PIP升级到最新：pipinstall--upgradepip。安装依赖1[[email protected]~]#yum-yinstallgccglibc-develzlib-develrpm-buildopenssl-devel安装Ansible1[[email prot 查看详情

idea中lombok的插件配置及使用(代码片段)

解释ProjectLombokisajavalibrarythatautomaticallyplugsintoyoureditorandbuildtools，spicingupyourjava.Neverwriteanothergetterorequalsmethodagain，withoneannotationyourclasshasafullyfeaturedbuilder，Automatey 查看详情

正文

gitbook实用配置及插件介绍(代码片段)

配置

title

author

description

language

links

styles

plugins

pluginsConfig

插件

Disqus

Search Pro

Advanced Emoji

Github

Ace Plugin

Emphasize

KaTex

Include Codeblock

Splitter

Mermaid

Sharing

Tbfed-pagefooter

Toggle Chapters

Sectionx

Codeblock-filename

ga

baidu

在线演示

gitbook入门教程之插件介绍(代码片段)

gitbook安装教程(代码片段)

gulp介绍及常用插件使用方法(代码片段)

jenkins——持续集成介绍及jenkins安装部署（插件+用户权限+凭据+maven打包）(代码片段)

gitbookeditor的相关介绍及与git、gitbook的区别

vscode常用插件及配置(代码片段)

实用的按键原理及应用(代码片段)

gitbook入门教程之网站域名备案icp插件(代码片段)

nginx实用插件(代码片段)

简单实用的jenkins部署及操作(代码片段)

web前端之vue的插件下载指令及介绍npminstallsave(代码片段)

vim插键及配置(代码片段)

用markdown写博客及markdown介绍(代码片段)

jenkins——jenkins介绍+基于云平台的jenkins安装和持续集成环境配置（插件+用户权限+凭据+maven打包）(代码片段)

简单实用的tomcat集群搭建技法及排错(代码片段)

maven变量及常见插件配置详解(代码片段)

002.ansible部署及配置介绍(代码片段)

idea中lombok的插件配置及使用(代码片段)