知识库-自动获取Gitbook的文档数据

Bothub 目前支持导入来自 Gitbook 的文档内容，您在配置 Bot 时通过简单的文章选择即可调用其中的单篇或者多篇文章，我们的后台会自动生成对应的卡片来展示给您的用户。具体包括以下三个步骤👇

下面我们将介绍上述步骤的具体操作和一些规范。

如何在 Gitbook 创建和编辑便于获取的知识库文档？

Gitbook 是一个提供免费文档编辑、发布和存储的平台，您只需要注册一个账号便可在 Gitbook 的平台上创建您需要的文档。

注册的账号名请不要带有下划线""，_因为后续生成的文档地址中会包括账户名，但是 Facebook 官方不支持带有下划线的地址。

下面，我们将通过一个例子来说明如何在 Gitbook 创建和编辑便于获取的知识库文档。👇 假设我们需要在 Gitbook 上创建一个如下所示的包含两篇文章的章节

章节名-Chapter 1: How to use Gitbook？
文章名-Create a Gitbook Account
文章名-Create a Gitbook

那么，我们要进行如下操作：

1.在 TABLE OF CONTENTS(TOC)视图下，空白处右击，选择“Add Part”来创建章节，以章节名进行命名；通过“Add an article”来添加文章，输入文章名后点击“Add”即可，并将该文章拖动到刚刚创建好的章节目录下。您也可以在此页面继续对文章内容进行编辑。

2. 在 FILES 视图下

2.1 创建对应章节的文件夹，文件夹命名支持的格式为 英文大小写字母、数字和减号 ，若输入其他格式的内容很有可能导致同步失败，无法识别内容。

2.2 将刚刚创建好的文章拖到该章节文件夹目录下

3. 返回TOC视图，在原有文章上右击选择“Edit Pointer”，在弹出的对话框中搜索选择位于章节文件夹下的文章文件。点击“Publish”，即可保存并发布。

为文章批量添加图片

通常，我们还需要将文章在 Messenger 以橱窗卡片的形式呈现，并配以图片来帮助用户识别与激发阅读兴趣。大多数情况下，一个主题下的文章会共用同一张图片。但有时我们也会需要为特定文章配以特定的图片。为了支持上述两种情况，我们提供了自动为文章配图的功能，具体操作如下：

如果您想为某个文章添加一张特定的图片，您需要将该图片保存为 jpg 格式并且以对应文章名称且包括后缀.md（例如：create-a-gitbook.md.jpg），然后将符合上述要求的图片上传到 FILES 的对应章节目录的文件夹下；
如果您想为同一章节下的多篇文章添加相同的图片，您需要将该图片以 cover.jpg来进行命名，然后将该图片上传到FILES 的对应章节目录的文件夹下。

我们后台读取一篇文章图片的顺序规则为： 按文件层级由下往上读取 。如果读取到对应文章名的图片文件则显示该图片，如果没有则继续读取；若读取到该文章所在文件夹存在 cover.jpg的图片文件则显示该文件，若没有读取到任何图片文件则不显示图片。

下面我们以一个例子作为说明👇

假设我们需要为文章Create a Gitbook Account配一张单独的图片，而这个章节下的其他文章则使用统一的配图。那我们需要在该章节目录的文件夹下上传两张图片文件，分别命名为“create-a-gitbook-account.md.jpg” 和"cover.jpg"。当我们在 Bothub 的后台创建并同步好后，这些图片就会显示出来。