站点密钥

site下配置的playbook密钥管理站点的发布身份以及发布后与某些应用程序的交互方式。

站点密钥

在playbook文件中,全局生成的站点文件、服务账户和其他常见属性在site密钥下定义。这些设置在生成站点时应用于整个站点。

site: (1)
  title: 文档站点 (2)
  url: https://docs.example.org (3)
  start_page: component-b::index.adoc (4)
  robots: allow (5)
  keys: (6)
    google_analytics: XX-123456 (7)
1 必需的site密钥
2 必需的title密钥
3 可选的url密钥
4 可选的start_page密钥
5 可选的robots密钥
6 可选的keys密钥
7 示例google_analytics密钥

site类别中的title密钥是必需的。url密钥是可选的,但建议设置。有关详细信息,请参阅何时应设置站点URL?。其他密钥是可选的;如果未指定,Antora将使用默认值。另外,titlestart_pagekeys可以从CLI分配url密钥可以从CLI或使用环境变量分配。

可用的站点密钥

站点密钥 描述 必需的

keys

用于UI模板或扩展引用的帐户和API密钥。接受指定服务集成的帐户标识符的名称-值对映射,例如Google Analytics。

robots

指定Antora是否生成robots.txt文件。接受值allowdisallow和自定义的多行字符串。如果未设置同级url密钥,则忽略。

start_page

接受指定站点起始页面的页面资源ID。

title

指定站点的标题。

url

指定站点的基本URL。