# @gitbook/adaptive 中文文档

规范地址：https://npmcn.com/package/%40gitbook/adaptive/

版本：1\.0\.2
npm 元数据更新时间：2026-03-31T14:08:22.270Z
中文译文更新时间：2026-11-16T10:31:42.857Z
软件包许可：未声明

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40gitbook/adaptive
原文对照：https://npmcn.com/package/%40gitbook/adaptive/?lang=original
项目主页：https://github.com/GitbookIO/integrations#readme
源码仓库：https://github.com/GitbookIO/integrations

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：40.1 kB，10 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2025-05-13T09:50:48.154Z
- 最新版本发布：2026-02-13T09:30:40.758Z
- 近 30 天下载量：30224（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：6（近 12 个月 1 个）

## 中文简介

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

## 安装

```sh
npm install @gitbook/adaptive
```

也可以使用：`pnpm add @gitbook/adaptive`、`yarn add @gitbook/adaptive`、`bun add @gitbook/adaptive`

## README

# `@gitbook/adaptive`

GitBook 的游戏 [适应内容](https://docs.gitbook.com/help/adaptive-content) 特性允许您根据访客数据对文档进行个性化。 这个 `@gitbook/adaptive` SDK提供公用设施,帮助将数据传送到GitBook,以适应您的内容.

此 SDK 包含两个功能旗帮助器, 供受欢迎的提供者使用 [暗地发射](https://launchdarkly.com/) 财务报告和审定财务报表 [废物](https://reflag.com/),以及用于编写客户数据的一般公用事业.

* * *

## 先决条件

确保你有:

-   启用具有适应内容的 GitBook 站点
-   正在启动的 Darkly 或 Reflag 项目
-   前端项目( 基于反应的) , 其中可使用特性标记的客户端

* * *

## 特性旗帜助手

SDK为受欢迎的功能旗提供商提供方便的帮助,使其能与GitBook的适应性内容系统自动同步旗下值.

### 暗地启动整合

#### 1\. 安装 GitBook + LaunchDarkly 集成

在 GitBook 中,安装 [**暗地发射**](https://app.gitbook.com/integrations/launchdarkly) 您的网站整合 .

#### 2\. 添加您的访问权限

在 GitBook 集成设置中,提供:

-    **项目密钥**
-   A 类 **服务访问符** 从您的启动黑暗账户

#### 3\. 安装 GitBook 助手

```bash
npm install @gitbook/adaptive
```

#### 4\. 配置客户

```tsx
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: 'sandy@example.com',
        },
        options: {}
    });

    render(
        <LDProvider>
            <PassFeatureFlagsToGitBookSite />
            <MyApplication />
        </LDProvider>,
        document.getElementById('reactDiv')
    );
})();
```

#### 访客Schema 输出

连接后, GitBook 中的特性旗值将会在 :

```
unsigned.launchdarkly.flags
```

### 监狱一体化

#### 1\. 安装 GitBook + Reflag 集成

在 GitBook 中,启用 [**废物**](https://app.gitbook.com/integrations/reflag) 您的网站整合 .

#### 2\. 添加您的密钥

在 GitBook 集成设置中,提供您的 **隐藏密钥**。 。 。 .

#### 3\. 安装 GitBook 助手

```bash
npm install @gitbook/adaptive
```

#### 4\. 配置客户

```tsx
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 的适应性内容系统中提供.

```tsx
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 是什么？

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 和提交记录判断。

