嵌入到您的产品中

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

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

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

概览

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

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

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

你可以使用自定义操作、工具、建议问题来定制和覆盖默认配置， 受限访问验证等更多功能。

快速开始

1

前提条件

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

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

2. 你已从站点设置中获取嵌入脚本的 URL （设置 → AI & MCP → 嵌入）。

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

2

实现

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

独立 script 标签

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

Node.js/NPM

通过 NPM 安装以便进行服务器端渲染或构建时控制

React 组件

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

如果你的文档使用 受限访问验证，请按照 如何在带有身份验证的文档中设置嵌入 的步骤操作.

3

配置

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

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

延伸阅读

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