Pipeline Event Reference

Antora pipeline extensions listen for events emitted by the site generator and other components in the Antora pipeline. Each listener can access variables that are in scope at the time the event is emitted. The following table lists the pipeline events in the order they’re emitted and the in-scope variables that correspond to each event. If the variable is locked, meaning it can’t be replaced, it’s marked with an asterisk (*).

Table 1. Antora pipeline events and in-scope variables
Event name In-scope variables

register()[1]

playbook, config

playbookBuilt

playbook

beforeProcess

playbook*, asciidocConfig, siteCatalog

contentAggregated[2]

playbook*, asciidocConfig*, siteCatalog, contentAggregate

uiLoaded[2]

playbook*, asciidocConfig*, siteCatalog, uiCatalog

contentClassified

playbook*, asciidocConfig*, siteCatalog, uiCatalog, contentCatalog

documentsConverted

playbook*, asciidocConfig*, siteCatalog, uiCatalog*, contentCatalog*

navigationBuilt

playbook*, asciidocConfig*, siteCatalog, uiCatalog*, contentCatalog*, navigationCatalog

pageComposed

playbook*, asciidocConfig*, siteCatalog, uiCatalog*, contentCatalog*

redirectsProduced

playbook*, asciidocConfig*, siteCatalog, uiCatalog*, contentCatalog*

siteMapped[3]

playbook*, asciidocConfig*, siteCatalog, uiCatalog*, contentCatalog*

beforePublish

playbook*, asciidocConfig*, siteCatalog, uiCatalog*, contentCatalog*

sitePublished

playbook*, asciidocConfig*, siteCatalog*, uiCatalog*, contentCatalog*, publications

In addition to the built-in pipeline variables listed in this table, your extension can also access pipeline variables documented and published by other extensions.


1. The register function isn’t an event, but rather the function Antora calls to register the extension itself.
2. The order of the contentAggregated and uiLoaded events relative to each other is not guaranteed.
3. The siteMapped event is only emitted if the site URL is specified in the playbook.