UI Output Directory

Default UI output directory

The UI files are published to a directory labeled with a single underscore, _ , located relative to the site’s output directory. For instance, when the site is published to the default site output directory (build/site), and no UI output_dir is specified, the UI files are written to build/site/_.

output_dir key

The output_dir key allows you to specify an alternate directory where Antora should publish the UI files. The path is relative to the root of the published site.

Example 1. Relative UI output path

ui:
  bundle:
    url: /home/user/projects/docs-ui/build/ui-bundle-with-themes.zip
    start_path: dark
  output_dir: _/dark

In this example, the site will be written to the default destination directory, therefore, the UI files will be published build/site/_/dark.

Antora will automatically reconfigure all references to the UI files, regardless of what value you use. This is thanks in part to the use of the {{uiRootPath}} placeholder in the UI templates.

In the next example, the site’s output directory (dir) is specified in addition to the UI output directory.

Example 2. Custom site and UI output directories

ui:
  bundle:
    url: /home/user/projects/docs-ui/build/ui-bundle-with-themes.zip
    start_path: dark
  output_dir: _/dark
output:
  dir: ./public

The UI files will be published to public/_/dark.