Site Keys

The playbook keys configured under site manage the site’s published identity and how it interacts with certain applications once it’s published.

site key

Global generated site files, service accounts, and other common properties are defined under the site key in a playbook file. These settings are applied to the entire site when it’s generated.

site: (1)
  title: Docs Site (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	Required `site` key
2	Required `title` key
3	Required `url` key
4	Optional `start_page` key
5	Optional `robots` key
6	Optional `keys` key
7	Optional `google_analytics` key

The site, title, and url keys are required. The other keys are optional; Antora will use their default values if they’re not specified.

Available site keys

Site Keys Description Required

Site Keys	Description	Required
keys.google_analytics	Associates a Google Analytics account with the site.	No
robots	Specifies whether Antora generates a robots.txt file. Accepts the values `allow`, `disallow`, and a custom, multi-line string. Ignored if the sibling `url` key is not set.	No
start_page	Accepts a page ID that specifies the start page of a site.	No
title	Specifies the title of a site.	Yes
url	Specifies the base URL of a site.	Yes

keys.google_analytics

Associates a Google Analytics account with the site.

robots

Specifies whether Antora generates a robots.txt file. Accepts the values allow, disallow, and a custom, multi-line string. Ignored if the sibling url key is not set.

start_page

Accepts a page ID that specifies the start page of a site.

title

Specifies the title of a site.

Yes

url

Specifies the base URL of a site.

Yes