嵌入到您的产品中

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

Docs 嵌入是一个强大的产品知识窗口，您可以将其添加到任何产品或网站。用户可以向 GitBook 助手 提问或直接浏览您的文档，而无需离开您的产品。您可以用按钮打开嵌入，将其放在任何您想要的组件中，或完全通过编程方式控制它。

将您的文档嵌入到产品或网站中

概览

Docs 嵌入由多个选项卡组成，会根据您站点的配置自动显示：

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

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

您可以使用自定义操作、工具、建议问题、 已验证访问等来自定义并覆盖默认配置。

快速开始

1

先决条件

在嵌入文档之前，请确保：

1. 您的文档已发布 并且可以通过一个 URL 访问（例如， https://docs.company.com).

2. 您已从站点设置中检索到嵌入脚本 URL （设置 → AI & MCP → 嵌入）。

如果您想使用“助手”选项卡， 必须为您的文档站点启用 GitBook 助手 （设置 → AI & MCP）。

2

实现

选择与您的设置相匹配的方法：

独立脚本标签

放入一个 <script> 标签以获得最快的设置，然后自定义其外观

Node.js/NPM

通过 NPM 安装以用于服务器端渲染或构建时控制

React 组件

使用预构建的 React 组件以实现无缝集成

如果您的文档使用 已验证访问，请按照 如何在已验证文档中设置嵌入的步骤进行操作.

3

配置

• 自定义嵌入 – 添加欢迎消息、自定义操作和建议

• 创建自定义工具 – 将助手连接到您的产品 API

延伸阅读

有关完整的 API 参考和源代码，请参见 @gitbook/embed GitHub 上的软件包.