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

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

{% method %}

内容区

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

主题允许使用模板块语法轻松地使用不同语言的示例来定义方法。一个方法块可以包含任意数量的嵌套 sample 和 common 块。

这些嵌套块如下所示。

示例块 方法块的正文将用作方法的定义，每个 sample 都将用于显示示例。 为此，每个 sample 块都应该使用 lang 参数指定一种语言。

在使用不同的语言管理示例时，这是非常好的，例如在记录多个API客户机时。

{% method %}

## Install {#install}

The first thing is to get the GitBook API client.

{% sample lang="js" %}

$ npm install gitbook-api

{% sample lang="go" %}

$ go get github.com/GitbookIO/go-gitbook-api
{% endmethod %}

howto

注意，sample 块可以包含为该语言显示的任何 Markdown 内容，而不仅仅是代码块，如下所示。common常用块用于显示示例中所有语言显示的内容。

{% method %}
## Simple method
{% sample lang="js" %}
This text will only appear for JavaScript.
{% sample lang="go" %}
This text will only appear for Go.
{% common %}
This will appear for both JavaScript and Go.
{% endmethod %}