Gitbook插件和主题

本文主要介绍gitbook的插件以及主题。

插件

插件是扩展Gitbook功能(电子书和网站)的最佳方式。现有的插件功能繁多：可支持数学公司，谷歌分析等。

怎么找插件呢？

可以在plugins.gitbook.com查找或者在NPM或者Github上找插件。

Gitbook的插件在NPM上都是以gitbook-plugin开头的，很容易查找的。

插件的安装和配置

插件安装很简单，只需要在book.json的plugins中增加相应插件就可以了。配置则需要根据不同插件来分别对待，但都是保存在pluginsConfig下的。

下面就常用的几款插件进行简单介绍下。

Disqus

Disqus是个非常流行的网站继承评论系统工具。Gitbook添加了该插件，则可以让读者在网页下面进行评论。

要使用该插件，则在book.json中增加如下代码。

{
    "plugins": ["disqus"],
    "pluginsConfig": {
        "disqus": {
            "shortName": "XXXXXXX"
        }
    }
}

代码中的shortName是在disqus官网上创建的website获得的唯一关键字。

但是如果某一个页面不想使用disqus的话，则可在页面中指定，如下代码。

---
disqus: false
---

# My Page without disqus

这里再说下shortName，希望大家能明白。

在disqus官网先注册一个账号，或者通过google,twitter,facebook账号授权注册都行。注册完了在Account页面可以看到Username，这个Username就是需要填写的shortName。

是不是这样就OK了呢？肯定不行，这是页面加载不上Disqus，为啥呢？需要你为你的网页增加一个site，登录后点击Admin，进入到管理页面。在管理页面选择Installing Disqus；然后在这个页面选择Create a Site，按要求填写后就可以管理你的Site了，在Site的设置页面填写好Website Name以及Website URL就可以了。注意的是Website URL是你访问的域名，比如.github.io。

设置好了，再次编译，发布以后就可以正常看到Disqus了。

books

这个是国人写的一个综合插件，是”为了节约空间而写的一个插件”。

books插件地址

由于该地址有详细介绍，我这里不在赘述了。

主题

从版本3.0.0以后，Gitbook能定制主题了。缺省书籍使用了theme-default主题。

主题的结构

其实主题也是一个插件，但它包含了模板和资源。任意主题都是继承自缺省主题，但可选覆盖任何主题模板。

目录	描述
_layouts	包含了所有模板的主目录
_layouts/website/page.html	单一页面模板
_layouts/ebook/page.html	在ebook生成时用到的单一页面模板(PDF<ePub,Mobi)

扩展/定制主题

作者可通过书籍的源代码直接扩展主题的模板(不需要另外创建主题)。模板首先会在数据的_layouts文件夹中解析，然后在安装插件/主题。

主题插件

Gitbook缺省的主题一般都够用了。除了用户可自行扩展主题外，还可通过NPM搜索主题插件。在NPM上，gitbook的主题插件一般都是以gitbook-theme开头的。

下面介绍几种常用主题插件。

theme-default

这个是缺省插件。这里将showLevel设为true，这样就会显示标题前面的数字索引，默认是不显示的。

{
    "theme-default": {
        "showLevel": true
    }
}

theme-comscore

comscore可以为标题增加颜色，而缺省主题都是黑白色的。

插件地址

要使用该插件，只需要将如下代码加入到book.json中。

{
	"plugins": [
        "theme-comscore"
 	]
 }

插件太多，只有选择自己合适的才是最好的。

可参考如下网址的插件介绍。

Gitbook插件