2019-01-05

Mac / 开发工具

6 分钟读完 (大约 931 个字) 0次访问

190105-GitBook配置与常用插件

GitBook配置与常用插件

GitBook配置与常用插件

GitBook 命令

这里将介绍GitBook的一些命令

输出gitbook的帮助信息

1	gitbook --help

生成静态网页并运行服务器

1	gitbook serve

生成静态网页

1	gitbook build

生成静态网页时指定gitbook的版本，如果本地没有将先下载

1	gitbook build --gitbook=3.2.3

列出所有的gitbook版本

1	gitbook ls

列出远程可用的gitbook版本

1	gitbook ls-remote

更新到gitbook的最新版本

1	gitbook update

卸载对应的gitbook版本

1	gitbook uninstall 3.2.3

安装依赖

1	gitbook install

指定log的级别

1	gitbook build --log=debug

输出错误信息

1	gitbook builid --debug

book.json 配置

非插件配置

title 设置书本的标题

1	"title" : “私人笔记”

author 作者的相关信息

1	"author": “lijiam”

description 本书的简单描述

1	"description" : “lijiam的私人笔记”

language Gitbook使用的语言

1	"language": “zh-hans”

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

"links" : {
    "sidebar" : {
        "Personal Book" : "http://www.gtwteam.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中设置

1
2
3

h1 , h2{
    border-bottom: 1px solid #EEEEEE;
}

plugins 插件列表

plugin 安装方式

book.json中添加插件，然后再执行gitbook install, 会下载所有添加的plugin
单个plugin安装，可使用npm安装，命令格式npm install gitbook-plugin-插件名字，如npm install gitbook-plugin-code
从GitHub下载源码，放到node_modules文件夹里。

chapter-fold 导航目录折叠

功能

支持多层目录，点击导航栏的标题名就可以实现折叠扩展。

安装配置

1
2
3

{
    "plugins": ["chapter-fold"]
}

chapter-fold

back-to-top-button（返回顶部）

功能

单篇文章内容过多时，直接点击按钮回到顶部

安装配置

1
2
3

{
    "plugins": ["back-to-top-button"]
}

code（代码添加行号&复制按钮）

功能
markdown中添加代码，显示行号以及复制按钮
安装配置

1
2
3

{
    "plugins": ["code"]
}

code

search-pro（高级搜索，支持中文）

功能
高级搜索，支持中文，搜索效果比默认搜索好很多
安装配置

1
2
3

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

github（在右上角添加github图标）

功能
右上方添加gitbook脚标
安装配置

1
2
3

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

插件配置信息

1
2
3

"github": {
            "url": "https://laosan.xin"
        }

tbfed-pagefooter（页面添加页脚，简单的）

功能

页面添加页脚

安装配置

1
2
3

{
    "plugins": ["tbfed-pagefooter"]
}

插件配置信息

"tbfed-pagefooter": {
        "copyright":"Copyright &copy laosan.xin 2020",
        "modify_label": "该文件修订时间：",
        "modify_format": "YYYY-MM-DD HH:mm:ss"
    }

tbfed-pagefooter

hide-element隐藏元素

功能

隐藏不想看到元素

安装配置

1
2
3

{
    "plugins": ["hide-element"]
}

插件配置

1
2
3

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

pageview-count（阅读量计数）

功能

页面阅读量统计

安装配置

1
2
3

{
    "plugins": ["pageview-count"]
}

book.json配置示例

{
    "title": "xxx记录",
    "author" : "laosan.xin",
    "description" : "记录了xxx",
    "language" : "zh-hans",
    "#links" : {
        "sidebar" : {
            "Home" : "https://www.baidu.com"
        }
    },
    "plugins": ["-sharing","-lunr","-search","back-to-top-button","chapter-fold","pageview-count","code","search-pro","github","splitter","tbfed-pagefooter","hide-element"],
    "pluginsConfig": {
        "hide-element": {
            "elements": [".gitbook-link"]
         },
         "github": {
            "url": "https://laosan.xin"
        },
        "tbfed-pagefooter": {
            "copyright":"Copyright &copy laosan.xin 2019",
            "modify_label": "该文件修订时间：",
            "modify_format": "YYYY-MM-DD HH:mm:ss"
        }
    }
}

本文参考链接

文本参考链接

# gitbook, 开发工具

文章

159

分类

标签

关注我