@gitbook/adaptive
GitBook 的游戏 适应内容 特性允许您根据访客数据对文档进行个性化。 这个 @gitbook/adaptive SDK提供公用设施,帮助将数据传送到GitBook,以适应您的内容.
此 SDK 包含两个功能旗帮助器, 供受欢迎的提供者使用 暗地发射 财务报告和审定财务报表 废物,以及用于编写客户数据的一般公用事业.
先决条件
确保你有:
- 启用具有适应内容的 GitBook 站点
- 正在启动的 Darkly 或 Reflag 项目
- 前端项目( 基于反应的) , 其中可使用特性标记的客户端
特性旗帜助手
SDK为受欢迎的功能旗提供商提供方便的帮助,使其能与GitBook的适应性内容系统自动同步旗下值.
暗地启动整合
1. 安装 GitBook + LaunchDarkly 集成
在 GitBook 中,安装 暗地发射 您的网站整合 .
2. 添加您的访问权限
在 GitBook 集成设置中,提供:
- 项目密钥
- A 类 服务访问符 从您的启动黑暗账户
3. 安装 GitBook 助手
npm install @gitbook/adaptive
4. 配置客户
import { render } from 'react-dom';
import { withLaunchDarkly } from '@gitbook/adaptive';
import { asyncWithLDProvider, useLDClient } from 'launchdarkly-react-client-sdk';
import MyApplication from './MyApplication';
function PassFeatureFlagsToGitBookSite() {
const ldClient = useLDClient();
React.useEffect(() => {
if (!ldClient) return;
return withLaunchDarkly(ldClient);
}, [ldClient]);
return null;
}
(async () => {
const LDProvider = await asyncWithLDProvider({
clientSideID: 'client-side-id-123abc',
context: {
kind: 'user',
key: 'user-key-123abc',
name: 'Sandy Smith',
email: '[email protected]',
},
options: {}
});
render(
<LDProvider>
<PassFeatureFlagsToGitBookSite />
<MyApplication />
</LDProvider>,
document.getElementById('reactDiv')
);
})();
访客Schema 输出
连接后, GitBook 中的特性旗值将会在 :
unsigned.launchdarkly.flags
监狱一体化
1. 安装 GitBook + Reflag 集成
在 GitBook 中,启用 废物 您的网站整合 .
2. 添加您的密钥
在 GitBook 集成设置中,提供您的 隐藏密钥。 。 。 .
3. 安装 GitBook 助手
npm install @gitbook/adaptive
4. 配置客户
import { withReflag } from '@gitbook/adaptive';
import { ReflagProvider, useClient } from '@reflag/react-sdk';
import MyApplication from './MyApplication';
function PassFeatureFlagsToGitBookSite() {
const client = useClient();
React.useEffect(() => {
if (!client) return;
return withReflag(client);
}, [client]);
return null;
}
export function Application() {
const currentUser = useLoggedInUser();
const appConfig = useAppConfig();
return (
<ReflagProvider
publishableKey={appConfig.reflag.publishableKey}
user={{
id: currentUser.uid,
email: currentUser.email ?? undefined,
name: currentUser.displayName ?? '',
}}
company={{
id: currentUser.company.id,
}}
>
<PassFeatureFlagsToGitBookSite />
<MyApplication />
</ReflagProvider>
);
}
访客Schema 输出
连接后, GitBook 中的特性旗值将会在 :
unsigned.reflag.flags
通用公用事业
如果您不使用LOUSTDAKLAK或Reflag,或者需要通过超过特性旗的自定义数据,SDK提供通用的功能来写入访问者数据.
写 GitBookVisitorCookie 游戏
这个 writeGitBookVisitorCookie 函数允许您写入自定义访问者数据,这些数据将在 GitBook 的适应性内容系统中提供.
import { writeGitBookVisitorCookie } from '@gitbook/adaptive';
// Write custom visitor data
writeGitBookVisitorCookie('userPlan', 'premium');
writeGitBookVisitorCookie('userRole', 'admin');
writeGitBookVisitorCookie('preferences', {
theme: 'dark',
language: 'en'
});
数据将在以下GitBook中提供:
unsigned.{cookieName}
例如,上述代码将创建:
unsigned.userPlan有数值"premium"unsigned.userRole有数值"admin"unsigned.preferences有数值{ theme: "dark", language: "en" }
重要说明
所有访客数据在客户端进行评价并被存储在饼干中. 不通过这种方法传递敏感或安全关键数据.