帐户和API密钥

keys 键接受名称-值对的映射，该映射指定用于服务集成(如 Google Analytics 或搜索工具)的帐户标识符。

keys键

keys 键是可选的。您可以在 playbook 中的 site 键下定义 keys 键。keys 接受一个名称-值对（也称为子键）的列表，用于指定帐户标识符。

Example 1. Example 1. antora-playbook.yml

site:
  title: Site Title
  url: https://example.org
  keys:
    name-of-account-key: 'identifier'
    google_analytics: 'XX-123456'

接着，UI 模板可以通过 UI 模型中的 site.keys 属性访问这些键的值。在分配给 UI 模型时，名称会转换为驼峰格式（无论名称中的单词是否使用连字符或下划线分隔）。例如，可以分别将上述示例中定义的键称为 site.keys.nameOfAccountKey 和 site.keys.googleAnalytics 。

站点密钥也可以通过 CLI 配置。

添加一个 Google Analytics 账户

google_analytics 键为站点分配一个 Google Analytics 帐户。当使用默认 UI 时，设置此选项会隐式启用 Google Analytics / Tag Manager 嵌入代码。

Example 2. Example 2. antora-playbook.yml

site:
  title: Demo Docs Site
  url: https://demo.antora.org
  keys:
    google_analytics: 'XX-123456'

我们建议将值用单引号(')括起来，以防止它被 YAML 解析器破坏。google_analytics 键还可以通过 CLI 和使用 GOOGLE_ANALYTICS_KEY 环境变量进行配置。