分析与集成

特性标志

使用 LaunchDarkly 控制文档可见性

以 Markdown 格式查看
团队版和企业版功能

此功能仅适用于团队版和企业版套餐。要开始使用，请联系 support@buildwithfern.com。

Fern 支持使用特性标志进行文档内容的条件渲染，由 LaunchDarkly 集成提供支持。根据不同发布阶段或用户群体的特性标志状态控制文档部分的可见性。

使用场景

文档中的特性标志特别适用于：

  • 区域内容：基于地理位置显示内容（例如，欧盟 vs 美国端点）
  • 产品层级：根据订阅级别显示功能
  • Beta 功能：允许特定用户查看 beta 文档
  • 分阶段发布：逐步发布新功能的文档
  • A/B 测试：为不同用户群体测试不同的文档方法

配置

在 docs.yml 中配置特性标志：

1navigation:
2  # 简单布尔标志
3  - page: Beta Features
4    feature-flag: beta-features
5
6  # 多个标志（如果任何标志为 true，内容将被显示）
7  - page: Advanced Features
8    feature:
9      - flag: feature-a
10      - flag: feature-b
11
12  # 可配置匹配
13  - section: Enterprise Features
14    feature-flag:
15      flag: release-stage
16      fallback-value: ga
17      match: beta

要了解更多关于 fallbackValue 和 match 的信息，请参阅 LaunchDarkly 文档。

在 MDX 中使用特性标志

使用 <Feature> 组件进行条件渲染内容：

1<Feature flag="deployment-region" match="commercial" fallbackValue="commercial">
2  <table class="fern-table">
3    <tr>
4      <th>服务</th>
5      <th>端点</th>
6    </tr>
7    <tr>
8      <td>API Gateway</td>
9      <td><code>https://api.example.com</code></td>
10    </tr>
11  </table>
12</Feature>

组件属性

flag
stringRequired

要检查的特性标志名称

match
boolean | stringRequired

与特性标志值匹配的值

fallbackValue
boolean | string

如果特性标志未定义时的默认值

示例：完整配置

1# docs.yml
2title: API Documentation
3navigation:
4  - section: Features
5    feature-flag: features-enabled
6    layout:
7      - page: Basic Features
8      - page: Advanced Features
9        feature-flag: advanced-features
10      - page: Beta Features
11        feature:
12          - flag: beta-access
13          - flag: beta-opted-in
14
15  - section: Enterprise
16    feature-flag:
17      flag: customer-tier
18      match: enterprise
19      fallbackValue: standard

实时评估

特性标志仅在客户端使用。当特性标志被评估为 false 时，信息仅在视觉上隐藏。

如果您在 LaunchDarkly 控制台中开启特性标志，内容将立即显示。

相反，如果您在 LaunchDarkly 控制台中关闭特性标志，内容将立即隐藏。

服务端评估

特性标志仅在客户端使用。希望请求服务端评估？让我们知道，通过提交功能请求。

其他特性标志提供商

希望请求新的特性标志提供商？让我们知道，通过提交功能请求。