Antora Keys

The playbook keys configured under antora configure the Antora site generator, specifically Antora extensions.

antora key

The antora key hosts the collection of registered Antora extensions.

Example 1. antora-playbook.yml
antora: (1)
  extensions: (2)
  - ./lib/audit-pages-extension.js (3)
  - require: '@antora/lunr-extension' (4)
    index_by_heading: true (5)
1 Optional antora key
2 Optional extensions key
3 Path to a local extension script
4 Path to an extension that accepts configuration
5 A configuration key for an extension

Available Antora keys

Antora Keys Description Required

extensions

Accepts a list of Antora extensions. Each entry can either be the require path of an extension, or it can be a map if subkeys to register and configure that extension.

No