自定义嵌入

通过设置欢迎信息、操作等来自定义将 Docs Embed 嵌入到您的产品或应用时的体验

在 将 Docs Embed 添加到您的网站或应用后，您可以通过向侧栏添加可操作按钮、向用户提供上下文问题建议等方式进一步自定义体验。

自定义按钮（独立 仅）

在使用 独立脚本标签实现时，您可以自定义启动嵌入小部件的按钮的标签和图标。

此按钮自定义选项仅在使用 独立脚本标签实现时可用。对于 React 或 Node.js/NPM 包 实现，您需要创建自己的按钮来启动嵌入。

window.GitBook("configure", {
  button: {
    label: "询问",
    icon: "assistant", // 'assistant' | 'sparkle' | 'help' | 'book'
  },
});

可用图标选项：

• assistant - 助手图标（默认）

• sparkle - 闪光图标

• help - 帮助/问号图标

• book - 书籍图标

添加操作

向嵌入添加操作可让您在 UI 中为用户提供额外的操作。每个操作由标签、图标（来自 Font Awesome）和一个 onClick 动作组成，当用户点击该操作时会运行。您添加的任何操作将出现在侧栏与选项卡并列。操作可以控制 Docs Embed 本身或执行您想要的任何代码。

window.GitBook("configure", {
  actions: [
    {
      label: "联系支持",
      icon: "circle-question",
      onClick: () => {
        window.open("https://support.example.com", "_blank");
      },
    },
    {
      label: "文档",
      icon: "book",
      onClick: () => {
        window.open("https://docs.example.com", "_blank");
      },
    },
  ],
});

添加建议

您可以向 Assistant 选项卡添加建议，这些建议将在 Assistant 加载时以可点击的提示形式显示给用户使用。

window.GitBook("configure", {
  suggestions: [
    "帮助我开始使用我的新账户",
    "我如何重置我的密码？",
    "你们的定价方案是什么？",
  ],
});

添加问候语

自定义在 Assistant 选项卡中显示的欢迎信息：

window.GitBook("configure", {
  greeting: {
    title: "欢迎！",
    subtitle: "我今天可以如何帮助您？",
  },
});

显示或隐藏商标

使用 trademark 来在嵌入 UI 中显示或隐藏 GitBook 商标 — 包括 Docs Embed 页脚和 Assistant 品牌。

window.GitBook("configure", {
  trademark: false,
});

配置选项卡

覆盖显示哪些选项卡。默认情况下，嵌入会根据您站点的配置显示选项卡。

window.GitBook("configure", {
  tabs: ["assistant", "docs"], // 同时显示两个选项卡
  // tabs: ['assistant'], // 仅显示 assistant 选项卡
  // tabs: ['docs'], // 仅显示 docs 选项卡
});