Skip to content

Latest commit

 

History

History
157 lines (128 loc) · 4.95 KB

themes.md

File metadata and controls

157 lines (128 loc) · 4.95 KB
Raw

主题

目前 GitBook 提供了三类文档： Book 文档、API文档、FAQ文档。我们常用的就是 Book 文档模式，如果我们需要使用 API 文档模式或者 FAQ 文档模式，只需引入文档对应的主题插件即可，下面我们介绍与这三类文档相关的主题插件。

Book

Book 是我们常用的模式，大部分插件也都是针对这个模式做的。下面介绍一下针对 Book 模式的两个主题。

theme-default

theme-default 是默认的 Book 主题。将 showLevel 设为 true， 就可以显示标题前面的数字索引，默认不显示。

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

在使用该主题的过程中，发现经常会在控制台报下面的错误，没有找到是哪里的原因，官方也一直没有修复。

theme.js:4 Uncaught TypeError: Cannot read property 'split' of undefined

后来在 这里 看到一个解决方法，需要修改本地的 GitBook Theme 模板。下面是具体步骤：

  • 进入 GitBook 默认主题所在的文件夹 用户主目录 -> .gitbook -> versions -> 3.2.2 -> node_modules -> gitbook-plugin-theme-default -> src -> js -> theme，打开 navigation.js，找到 getChapterHash 函数
function getChapterHash($chapter) {
    var $link = $chapter.children('a'),
        hash = $link.attr('href').split('#')[1];

    if (hash) hash = '#'+hash;
    return (!!hash)? hash : '';
}
  • 将该函数修改为下面的形式:
function getChapterHash($chapter) {
    var $link = $chapter.children('a'),
        hash,
        href,
        parts;

    if ($link.length) {
        href = $link.attr('href')
        if (href) {
            parts = href.split('#');
            if (parts.length>1) {
                hash = parts[1];
            }
        }
    }

    if (hash) hash = '#'+hash;
    return (!!hash)? hash : '';
}
  • 回到 gitbook-plugin-theme-default 文件夹，运行 npm install 重新编译文件。

theme-comscore

为标题添加颜色，如下如所示

插件地址

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

API 文档

GitBook 同样可以编写 API 文档，只需要引入 theme-api 插件

{
    "plugins": ["theme-api"],
    "pluginsConfig": {
        "theme-api": {
            "theme": "dark"
        }
    }
}

引入之后会替换默认的样式。下面是 API 文档的样式截图和在线演示：

在线演示    示例源码

使用 GitBook 的 API 文档模式时也可以使用插件，但是因为大部分插件可能针对写书的模式，所以有可能会出现不兼容的现象。

API文档的语法也很简单，因为主要是针对方法的，所以以方法为基本单位，通过下面的语法来定义一个方法 {% raw %}

{% method %}

内容区

{% endmethod %}

在内容区里面，通过 {% sample lang="lang" %} 来定义一个针对特定语言的演示，通过 {% common %} 标识所有语言共同的部分。下面是一个完整的示例：

{% method %}
## 打印

展示 JavaScript 和 Java 如何输出信息

{% sample lang="js" %}
这里演示 JavaScript 如何输出信息到控制台

```js
console.log('Hello World');
```

{% sample lang="java" %}
这里演示 Java 如何输出信息到控制台

```java
System.out.println("Hello World");
```

{% common %}
这里是 JavaScript 和 Java 共同的信息

{% endmethod %}
```

{% endraw %}

FAQ 文档

theme-faq 插件主要用来制作知识库或者帮助中心，GitBook 的 帮助中心 就是使用的该主题。为了支持中文搜索我们需要引入 search-pro 包。

{
    "plugins": [
        "theme-faq",
        "-lunr",
        "search-pro@^2.0.2"
    ]
}

下面是该主题的截图以及在线示例：

在线演示    示例源码

编写帮助中心很简单，在 Summary 里配置问题以及答案所在的文件，在对应文件中写入问题的答案即可，下面是一个示例
SUMMARY.md

# Summary

* [什么 is Git](Git.md)
* [什么 is Github](Github.md)

Git.md

Git 是一个分布式版本控制软件，最初由林纳斯·托瓦兹（Linus Torvalds）创作，于2005年以GPL发布。最初目的是为更好地管理Linux内核开发而设计。应注意的是，这与GNU Interactive Tools[6]（一个类似Norton Commander界面的文件管理器）有所不同。