Output Keys

The playbook keys configured under output define where the site files are written (i.e., published) and how that target is prepared.

output key

The output key contains common output settings and a list of destination specifications.

Example 1. antora-playbook.yml

output: (1)
  clean: true (2)
  dir: ./public (3)
  destinations: (4)
  - provider: fs (5)
  - provider: archive (6)
    path: ./public/blue.zip (7)

1	Optional `output` key
2	Optional `clean` key
3	Optional `dir` key
4	Optional `destinations` key
5	Primary `provider` entry to support `dir` key when using `destinations` key
6	Optional `provider` entry to produce an archive

The output key and the key-value pairs it can accept are optional. When output isn’t set in a playbook, Antora uses the fs provider and publishes the site to the default output directory, ./build/site. In other words, the default behavior assumes the following configuration:

Example 2. antora-playbook.yml

output:
  dir: ./build/site
  destinations:
  - provider: fs

destinations and provider keys

The output key accepts the destinations key, which hosts the destination specifications. The destinations key is required if you want to publish the site files as an archive, publish a site to multiple destinations, or publish the site using a custom provider.

The destinations key accepts a list of specifications that tell Antora which provider(s) to use to publish the site and where the generated files should be saved. When destinations is set, each entry must at least specify the provider key.

If you want to support the primary fs destination, you must include an entry for it without defining the path key.

A provider determines which transport protocol (local, SSH, HTTP, etc.) Antora should use when publishing the site and manages the low-level details of publication. Antora has two built-in providers, fs (filesystem) and archive (ZIP archive). provider is also an extension point that can be used to delegate to a custom provider, such as SSH, S3, etc.

Disable site publishing

To disable publishing the site files entirely, including to the primary fs destination, set the destinations key to an empty array ([]). In this case, the value of the dir key, if any, is ignored.

output:
  destinations: []

Alternately, you can set the dir key to a null or empty value without setting the destinations key.

output:
  dir: ~

If you set the dir key to a non-empty value, it will be used as the path for the primary fs destination.

Available output keys

Output Keys Description Required

Output Keys	Description	Required
clean	When set to `true`, the `clean` key removes the output directory or filesystem provider path recursively before generating the site. The value of this key is the default value for any destination entry that doesn’t specify the `clean` key.	No
destinations[n].clean
destinations[n].path	Designates the target location where the output file(s) are written. See Filesystem provider and path and Archive provider and path.	No
destinations[n].provider	Specifies the transport protocol Antora uses to publish the site. Accepts the built-in fs or archive values. Custom providers can also be specified. Multiple providers can be specified under `destinations`.	No
dir	Specifies an output directory when the site is published using the primary fs destination (either when no destinations are specified or the first entry specified under `destinations` whose provider is `fs` and whose `path` key is not set). This key is effectively the value for the primary fs destination.	No

clean

When set to true, the clean key removes the output directory or filesystem provider path recursively before generating the site. The value of this key is the default value for any destination entry that doesn’t specify the clean key.

destinations[n].clean

destinations[n].path

Designates the target location where the output file(s) are written. See Filesystem provider and path and Archive provider and path.

destinations[n].provider

Specifies the transport protocol Antora uses to publish the site. Accepts the built-in fs or archive values. Custom providers can also be specified. Multiple providers can be specified under destinations.

dir

Specifies an output directory when the site is published using the primary fs destination (either when no destinations are specified or the first entry specified under destinations whose provider is fs and whose path key is not set). This key is effectively the value for the primary fs destination.