URLs Keys

The playbook keys configured under urls manage the site’s published URLs and redirects.

urls key

The global properties of your site’s published URLs and redirect facility are defined under the urls key in a playbook file.

urls: (1)
  html_extension_style: drop (2)
  redirect_facility: ngnix (3)
  latest_version_segment_strategy: redirect:to (4)
  latest_version_segment: stable (5)
  latest_prerelease_version_segment: unstable (6)
1 Optional urls key
2 Optional html_extension_style key
3 Optional redirect_facility key
4 Optional latest_version_segment_strategy key
5 Optional latest_version_segment key
6 Optional latest_prerelease_version_segment key

Antora uses the default values for the html_extension_style and redirect_facility keys if they’re not specified. The html_extension_style and redirect_facility keys are also configurable from the Antora CLI.

Available urls keys

URLs Keys Description Required

html_extension_style

Specifies the user-facing URL extension used for HTML pages. Accepts the values default, drop, and indexify.

No

latest_prerelease_version_segment

Symbolic prerelease version that Antora uses to replace the actual version in the version segment of page and asset URLs. Only applies to the latest prerelease component version.

No

latest_version_segment

Symbolic version that Antora uses to replace the actual version in the version segment of page and asset URLs. Only applies to the latest component version.

No

latest_version_segment_strategy

Controls the replacement and redirect direction between URLs containing the actual version and URLs containing the symbolic version. Only applies to the latest component version or latest prerelease component version. Accepts the values replace, redirect:to, and redirect:from.

No

redirect_facility

Specifies whether Antora generates redirects as static HTML refresh pages or redirect configuration files. Accepts the values disabled, httpd, netlify, ngnix, and static.

No