其他拓展

除了book.json配置,还有一些其他拓展功能。

文件内容引用

{% include "../SUMMARY.md" %}

会直接引入文件中的内容

以代码的形式引入内容

通过Include Codeblock 插件,实现通过代码的形式引入文件内容

多语言

GitBook支持使用多语言来构建书本。按照GitBook的标准格式,每个语言应该作为一个子目录,命名为LANGS.md的文件应该遵循下面的格式并出现在仓库的根目录下:

* [英语](en/)
* [法语](fr/)
* [西班牙语](es/)

你可以从Learn Git这本书中看到一个完整的例子。

术语表

允许你指定术语并且在术语表中显示它们各自的定义。基于这些术语,GitBook会自动建立索引并高亮这些在文中的术语。

GLOSSORY.md的格式非常简单:

# 术语
这个术语的定义

# 另外一个术语
它的定义可以包含粗体和其他所有类型的内嵌式标记...

Github集成

参看发布到GitHub仓库

封面及icon

绑定域名

参考:http://www.chengweiyang.cn/gitbook/gitbook.com/config/domain.html

锚点的设置

锚点,其实是link,设置link时候,选择对应的文件,将跳转到对应的文件。

[安装](installAndCommand/installStep.md)

.md文件中 H2将自动生成#锚点, 通过设置link 对应锚点就可以跳转到对应位置。

[author](/configInfo/bookjson.md#author)

同文件中的锚点不用指定文件名,直接通过[author](#author)

转义

如果你想要输出任何特殊的目标标签,你可以使用raw,任何在其中的内容都会原样输出。

{% raw %}
  这 {{ 不会被处理 }}
{% endraw %}

其他主题类型

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

(或者可以在Gitbook网站上创建项目时候进行选择主题,将自动进行配置)

Book:

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

API文档

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

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

在线演示 示例源码

FAQ 文档

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

在线演示 示例源码

results matching ""

    No results matching ""