@gitbook/adaptive

中文文档
1.0.2发布于 2026/02/13TypeScriptESM + CJS构建来源已验证近 30 天下载 3万

GitBook 中使用适应性内容的工具

中文使用文档
文档目录7 节
  1. 先决条件
  2. 特性旗帜助手
  3. 暗地启动整合
  4. 监狱一体化
  5. 通用公用事业
  6. 写 GitBookVisitorCookie 游戏
  7. 重要说明

@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" }

重要说明

所有访客数据在客户端进行评价并被存储在饼干中. 不通过这种方法传递敏感或安全关键数据.

版本与发布记录

@gitbook/adaptive 共发布 6 个版本,首次发布于 2025/05/13;过去 12 个月发布了 1 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
1.0.2latest2026/02/139 个月前
1.0.02025/09/091.2 年前
0.1.12025/06/221.4 年前
0.1.02025/06/091.4 年前
0.0.22025/05/131.5 年前
0.0.12025/05/131.5 年前

关于 @gitbook/adaptive 的常见问题

@gitbook/adaptive 是什么?

GitBook 中使用适应性内容的工具

如何安装 @gitbook/adaptive?

在项目目录运行 npm install @gitbook/adaptive,或使用 pnpm add / yarn add / bun add。

@gitbook/adaptive 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@gitbook/adaptive 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@gitbook/adaptive 可以商用吗?

@gitbook/adaptive 使用 未声明 许可。package.json 没有声明许可证。没有许可证的代码默认保留全部权利,商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括,不构成法律意见,请以许可原文为准。

@gitbook/adaptive 的下载量有多少?

根据 npm 官方下载统计,@gitbook/adaptive 在 2026/10/17 – 2026/11/15 这 30 天内被下载 30,224 次,日均约 1,007 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@gitbook/adaptive 还在维护吗?

最新版本 1.0.2 发布于 2026/02/13(9 个月前);至今共发布 6 个版本,其中过去 12 个月发布了 1 个;首次发布于 2025/05/13。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。