Account and API Keys
keys key accepts a list of name-value pairs that specify account identifiers that are used by global site services such as search tools and Google Analytics.
keys key is optional.
You define the
keys key under the site key in a playbook.
keys accepts a list of name-value pairs (aka subkeys) that specify account identifiers.
site: title: Site Title url: https://example.org keys: name-of-account-key: 'identifier' google_analytics: 'XX-123456'
The value of these keys can then be accessed by a UI template from the
site.keys property in the UI model.
When assigned to the UI model, the name is converted to camelCase (regardless of whether words in the name are separated using hyphens or underscores).
For example, you can access the keys defined in the example above as
google_analytics key assigns a Google Analytics account to the site.
site: title: Demo Docs Site url: https://demo.antora.org keys: google_analytics: 'XX-123456'
We recommend enclosing the value in single quotation marks (
') to prevent it from being mangled by the YAML parser.