For the complete documentation index, see llms.txt. This page is also available as Markdown.

嵌入到你的产品中

使用 Docs Embed 将你的文档嵌入到产品或网站中。

Docs Embed 是一个强大的窗口,可让你了解你的产品知识,并可添加到任何产品或网站中。用户可以向它提问 GitBook 助手,搜索你的文档,或直接浏览页面,而无需离开你的产品。你可以通过按钮打开该嵌入,将其放入你想要的任何组件中,或完全通过编程控制它。

Embed GitBook Assistant into your product or website
将你的文档嵌入到你的产品或网站中

概览

Docs Embed 可包含三个选项卡:

  • 助手: GitBook 助手 — 一个由 AI 驱动的聊天界面,帮助用户找到答案

  • 搜索:一个以搜索为重点的界面,可快速查找页面并提出范围限定的问题

  • 文档:用于浏览你的文档站点的浏览器

默认情况下启用所有选项卡。如果你设置 tabs,嵌入内容将仅显示你列出的选项卡。

你可以使用自定义操作、工具、建议问题来自定义并覆盖默认配置, 经身份验证的访问,等等。

开始使用

1

前置条件

在嵌入你的文档之前,请确保:

  1. 你的文档已发布 并可通过一个 URL 访问(例如, https://docs.company.com).

  2. 你已获取嵌入脚本 URL ,可在你的网站设置中找到(设置 → AI & MCP → 嵌入)。

如果你想使用助手选项卡, 必须启用 GitBook Assistant ,用于你的文档站点(设置 → AI & MCP)。

2

实现方式

使用我们的技能,借助你现有的技术栈快速将 GitBook Assistant 集成到你的产品中。

或者,继续阅读文档,选择适合你配置的方案:

3

配置

延伸阅读

如需完整的 API 参考和源代码,请查看 @gitbook/embed GitHub 上的包.

最后更新于

这有帮助吗?