账户和API密钥

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

keys键

keys键是可选的。您可以在playbook中的站点键下定义keys键。 keys接受一组名称-值对(也称为子键),用于指定帐户标识符。

示例1. antora-playbook.yml
site:
  title: 站点标题
  url: https://example.org
  keys:
    name-of-account-key: '标识符'
    google_analytics: 'XX-123456'

然后,可以通过UI模板从UI模型中的site.keys属性访问这些键的值。当分配给UI模型时,名称将转换为驼峰命名法(无论名称中的单词是使用连字符还是下划线分隔的)。例如,您可以分别访问上面示例中定义的键为site.keys.nameOfAccountKeysite.keys.googleAnalytics

还可以从CLI中配置站点键。

添加Google Analytics帐户

google_analytics键将Google Analytics帐户分配给站点。设置此选项将在使用默认UI时隐式启用Google Analytics / Tag Manager嵌入代码。

示例2. antora-playbook.yml
site:
  title: 演示文档站点
  url: https://demo.antora.org
  keys:
    google_analytics: 'XX-123456'

我们建议将值用单引号(')括起来,以防止YAML解析器对其进行篡改。 google_analytics键也可以从CLI和使用GOOGLE_ANALYTICS_KEY环境变量进行配置。