> For the complete documentation index, see [llms.txt](https://gitbook.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://gitbook.com/docs/documentation/zh/fa-bu/adaptive-content/enabling-adaptive-content/feature-flags.md).
# 功能标志
{% hint style="warning" %}
使用带有功能标记的自适应内容需要向您的应用程序添加代码。
目前，GitBook helper 仅支持基于 React 的设置。
{% endhint %}
GitBook 为以下流行的特性标记服务提供商提供辅助函数和集成： [**LaunchDarkly**](#launchdarkly) 并 [**Reflag**](#reflag).
这使你能够在用户阅读你的文档时，读取他们在产品中有权访问的特性标记。如果你需要为仅对特定人群可用的功能展示文档，这将非常有用。
### LaunchDarkly
LaunchDarkly 允许你通过以下方式将特性标记访问权限作为声明发送： [`launchdarkly-react-client-sdk`](https://launchdarkly.com/docs/sdk/client-side/react/react-web) 以及 GitBook 的 [`@gitbook/adaptive`](broken://spaces/zq8ynchcecIscc4uulgN) 包。
如果你已经在产品中使用 LaunchDarkly 特性标记，那么大概率你已经配置好了这个包。
要将这些特性标记作为声明传递给 GitBook，请按以下步骤操作：
{% stepper %}
{% step %}
**安装 LaunchDarkly 集成**
开始之前，你首先需要 [安装 LaunchDarkly 集成](https://app.gitbook.com/integrations/launchdarkly) 到你的 GitBook 站点中。
{% endstep %}
{% step %}
**设置你的项目和访问密钥**
将你的项目密钥以及来自你的 [LaunchDarkly 设置](https://app.launchdarkly.com/settings) 中的服务访问令牌添加到该集成的配置中。
{% endstep %}
{% step %}
**安装并将 GitBook helper 添加到你的应用中**
在设置好 LaunchDarkly 集成后，你需要在应用中安装 GitBook 自适应内容 helper。
```bash
npm install @gitbook/adaptive
```
{% endstep %}
{% step %}
**配置你的应用**
你需要使用 `withLaunchDarkly` helper 配合 LaunchDarkly React SDK，将上下文传递给 GitBook。
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'),
);
})();
{% endstep %}
{% step %}
**检查你的 visitor schema**
一项 [visitor schema](/docs/documentation/zh/fa-bu/adaptive-content/enabling-adaptive-content.md#set-your-visitor-schema) 是必需的，这样你的声明才能在已发布的网站中被读取。安装并配置 LaunchDarkly 集成应会自动为你设置 visitor schema。
{% endstep %}
{% step %}
**个性化你的内容**
设置好 visitor schema 后，你就可以使用用户可访问的特性标记，为访问你站点的用户定制文档体验了。
LaunchDarkly 中可用的任何特性标记值都会作为 visitor schema 的一部分暴露在 `visitor.claims.unsigned.launchdarkly` 对象下。阅读更多关于未签名声明的内容 [这里](/docs/documentation/zh/fa-bu/adaptive-content/enabling-adaptive-content.md#set-an-unsigned-claim).
前往 [调整你的内容](/docs/documentation/zh/fa-bu/adaptive-content/adapting-your-content.md) 以了解更多如何为你的用户个性化文档。
{% endstep %}
{% endstepper %}
### Reflag
Reflag 允许你通过以下方式将特性标记访问权限作为声明发送： [`@reflag/react-sdk`](https://www.npmjs.com/package/@reflag/react-sdk) 以及 GitBook 的 [`@gitbook/adaptive`](https://github.com/GitbookIO/integrations/tree/main/packages/adaptive) 包。
如果你已经在产品中使用 Reflag 特性标记，那么大概率你已经配置好了这个包。
要将这些特性标记作为声明传递给 GitBook，请按以下步骤操作：
{% stepper %}
{% step %}
**安装 Reflag 集成**
开始之前，你首先需要 [安装 Reflag 集成](https://app.gitbook.com/integrations/bucket) 到你的 GitBook 站点中。
{% endstep %}
{% step %}
**设置你的密钥**
将你的密钥添加到你的 [Reflag 设置](https://app.reflag.com/envs/current/settings/app-environments) 中的服务访问令牌添加到该集成的配置中。
{% endstep %}
{% step %}
**将 GitBook helper 安装到你的应用中**
在设置好 Reflag 集成后，你需要在应用中安装 GitBook 自适应内容 helper。
```bash
npm install @gitbook/adaptive
```
{% endstep %}
{% step %}
**配置你的应用**
你需要使用 `withReflag` helper 配合 Reflag React SDK，将上下文传递给 GitBook。
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.reflagCom.publishableKey}
user={{
id: currentUser.uid,
email: currentUser.email ?? undefined,
name: currentUser.displayName ?? '',
}}
company={{
id: currentUser.company.id,
}}
>
<PassFeatureFlagsToGitBookSite />
<MyApplication />
</ReflagProvider>
);
}
{% endstep %}
{% step %}
**检查你的 visitor schema**
一项 [visitor schema](/docs/documentation/zh/fa-bu/adaptive-content/enabling-adaptive-content.md#set-your-visitor-schema) 是必需的，这样你的声明才能在已发布的网站中被读取。安装并配置 Reflag 集成应会自动为你设置 visitor schema。
{% endstep %}
{% step %}
**个性化你的内容**
设置好 visitor schema 后，你就可以使用用户可访问的特性标记，为访问你站点的用户定制文档体验了。
Reflag 中可用的任何特性标记值都会作为 visitor schema 的一部分暴露在 `visitor.claims.unsigned.reflag` 对象下。阅读更多关于未签名声明的内容 [这里](/docs/documentation/zh/fa-bu/adaptive-content/enabling-adaptive-content.md#set-an-unsigned-claim).
前往 [调整你的内容](/docs/documentation/zh/fa-bu/adaptive-content/adapting-your-content.md) 以了解更多如何为你的用户个性化文档。
{% endstep %}
{% endstepper %}
{% hint style="info" %}
特性标记值是在客户端进行评估的，因此请避免使用此方法传递敏感或安全关键数据。
{% endhint %}
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://gitbook.com/docs/documentation/zh/fa-bu/adaptive-content/enabling-adaptive-content/feature-flags.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.