知识库,自动获取 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 以橱窗卡片的形式呈现,并配以图片来帮助用户识别与激发阅读兴趣。大多数情况下,一个主题下的文章会共用同一张图片。但有时我们也会需要为特定文章配以特定的图片。为了支持上述两种情况,我们提供了自动为文章配图的功能,具体操作如下:

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

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

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

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

如何创建与同步知识库?

在数据集成中,找到知识库,进入并点击“添加知识库”,会弹出一张表单。其中,知识库名称是可以自定义的,其余要填写的项目则需要在您刚刚创建的 Gitbook 中获取。填写完成后,我们的后台则会进行信息验证。验证成功后,您便可以进入查看详细内容。

  • 域名:Gitbook 文档的地址 在 Gitbook 的主页面找到该文档,点击 Settings,选择 Domains,即可找到该文档的地址。

  • Creater : 你的 Gitbook账号的用户名

  • Book:Gitbook 文档的名称

  • Access Token: 需要主动获取

如何调用文章?

当您在 Bothub 后台创建好已验证通过的知识库后,便可在编辑 Bot 的时候对知识库里的文章进行调用。目前我们提供两种调用方式,分别是通过按钮调用和通过插件调用。

通过按钮调用

在橱窗卡片下添加“知识库”按钮,接着在弹出的对话框中选择您知识库里的文章并设置弹出的网址的高度,然后点击完成。我们的后台便会自动添加该文章的网址,并将该按钮的名称设置为“Read this”。

通过插件调用

选择“知识库”高级插件,接着在弹出的对话框中选择您知识库里的文章并设置弹出的网址的高度,然后点击完成,便会生成一张橱窗卡片。

这个橱窗卡片会自动配置一个“Read This”的按钮,并且自动填充了您刚刚选择的文章的地址。如果您事先上传了图片则会自动填充对应的图片。上述内容都可以进行再次编辑以修改。

results matching ""

    No results matching ""