启用自适应内容

选择一种身份验证方法以将用户数据传递给 GitBook。

要开始为读者定制您的文档体验，您需要启用自适应内容并决定如何将访客数据传递给 GitBook。这使您站点的内容能够根据查看者动态调整。

启用自适应内容

在您能够将用户数据传递给 GitBook 之前，您需要将站点配置为使用自适应内容。

前往您的 站点设置，并在站点的受众设置中启用“自适应内容”。启用后，您将获得一个生成的“访客令牌签名密钥”，您需要该密钥以继续自适应内容的设置。

启用自适应内容

设置您的访客模式(schema)

启用自适应内容后，您需要为在用户访问您站点时预期 GitBook 会接收的声明类型定义一个模式。

访客模式应反映这些声明在发送到 GitBook 时的结构。

例如，如果您预期访客可能是您产品中的测试用户（beta 用户），您可以设置类似于以下的访客模式：

{
  "type": "object",
  "properties": {
    "isBetaUser": {
      "type": "boolean",
      "description": "访客是否为 Beta 用户。"
    }
  },
  "additionalProperties": false
}

这也将帮助您在在配置声明时使用自动完成，位于 条件编辑器。访客模式仅支持以下类型：

字符串

将作为字符串传递的读取声明。

字符串 必须包含一个 enum 键，该键需要包含在被读取的键上可能出现的任何预期值。

{
  "type": "object",
  "properties": {
    "language": {
          "type": "string",
          "description": "访客的语言",
          "enum": [
            "en",
            "fr",
            "it"
          ]
  },
  "additionalProperties": false
}

布尔值

将作为布尔值传递的读取声明。

{
  "type": "object",
  "properties": {
    "isBetaUser": {
      "type": "boolean",
      "description": "访客是否为 Beta 用户。"
    },
  },
  "additionalProperties": false
}

对象

将声明嵌套在对象中以分组相似的值。

{
  // 顶级声明
  "type": "object",
  "properties": {
    // 嵌套声明
    "access": {
      "type": "object",
      "description": "用户对产品功能的访问",
      "properties": {
        "isAlphaUser": {
          "type": "boolean",
          "description": "访客是否为 Alpha 用户。"
        },
        "isBetaUser": {
          "type": "boolean",
          "description": "访客是否为 Beta 用户。"
        },
      },
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

设置未签名声明

未签名声明是一类特定的声明，用于标识可能未由客户端应用签名而传入的声明。如果您通过 URL 参数、未签名的 cookie 和功能标志传递声明，则需要在访客模式中将这些声明设置为 未签名的 。

如果您打算处理未签名声明，您需要在模式中在与已签名声明并列的“unsigned”属性下声明您预期的声明。

{
  "type": "object",
  "properties": {
    "isBetaUser": {
      "type": "boolean",
      "description": "访客是否为 Beta 用户。"
    },
    // 添加未签名声明
    "unsigned": {
      "type": "object",
      "description": "站点访客的未签名声明。",
      "properties": {
        "language": {
          "type": "string",
          "description": "访客的语言",
          "enum": [
            "en",
            "fr",
            "it"
          ]
        }
      },
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

将访客数据传递给 GitBook

GitBook 提供了不同的方式来传递访客数据以使站点内容适配。定义模式后，您需要决定如何将访客数据传递给 GitBook。

Cookie

通过公共或签名的 cookie 将访客数据传入文档。

显示的

通过 URL 查询参数将访客数据传入文档。

功能标志

通过功能标志提供者将访客数据传入文档。

经过身份验证的访问

通过身份验证提供者将访客数据传入文档。