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

启用自适应内容

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

要开始为读者自定义你的文档体验,你需要启用自适应内容,并决定访客数据如何传递给 GitBook。这样你的网站内容就能根据访问者动态调整。

启用自适应内容

在你能够将用户数据传递给 GitBook 之前,你需要配置你的网站以使用自适应内容。

前往你的 网站设置,并启用 自适应内容 来自你网站的受众设置。启用后,你将获得一个生成的“访客令牌签名密钥”,你需要它才能继续进行自适应内容设置。

A GitBook screenshot showing the enable adaptive content toggle
在你网站的设置中启用自适应内容

设置你的访客架构

启用自适应内容后,你需要为当用户访问你的网站时 GitBook 预期接收的声明类型定义一个架构。

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

例如,如果你预计访客在你的产品中可能是测试版用户,你可以设置类似如下的访客架构:

这也会帮助你在配置声明时使用自动补全, 条件编辑器. 访客架构仅支持以下类型:

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

GitBook 支持动态字符串,这意味着你可以动态传递字符串数据——例如用户姓名、开发者令牌等。

字符串还可以包含一个 可选的枚举 键,这使你可以将 GitBook 接收到的数据限制为其预设值之一。

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

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

设置未签名声明

未签名声明是一种特定类型的声明,用于识别可能未经过客户端应用签名传入的声明。如果你要通过以下方式传递声明,则需要在访客架构中将声明设置为 未签名的 如果你通过 URL 参数、未签名 cookie 和功能标志传递声明。

如果你打算使用未签名声明,你需要在架构中的“unsigned”属性下,将你预期接收的声明与已签名声明并列声明。

将访客数据传递给 GitBook

GitBook 提供多种方式来传递访客数据,以便调整你网站的内容。定义好架构后,你需要决定希望如何将访客数据传递给 GitBook。

最后更新于

这有帮助吗?