Antora Maven Plugin Documentation

The Antora Maven plugin provides an interface for running Antora in a Maven project.

When using this plugin, you don’t need to have Node.js or Antora preinstalled. Instead, you rely on the plugin to set up and run Antora using the configuration specified in the plugin declaration or one of its executions.

Overview

The Antora Maven plugin enhances the Maven build to provide support for Antora as follows:

  • antora:antora Goal - A goal named antora:antora that installs Node.js, npm, and Antora, then invokes Antora.

  • antora:help Goal - A goal named antora:help that displays help information for the plugin goals and configuration parameters.

  • antora Lifecycle - A discrete Maven lifecycle for building Antora projects.

Features

The Antora Maven plugin provides the following capabilities and features:

  • Run Antora from a Maven build without needing Node.js or Antora installed on the system.

  • Specify the exact or fuzzy version of Antora to install using either the configuration block, package.json, or a special comment syntax in a provided Antora playbook file.

  • Specify additional Node.js packages to install using either the configuration block, package.json, or a special comment syntax in a provided Antora playbook file.

  • Set Antora CLI options and environment variables using the configuration block.

  • Pass CLI options to Antora when invoking Maven using system properties.

  • Define additional executions to add or override CLI options and environment variables that are passed to Antora.

  • Manage and retrieve the Antora playbook from a local or remote branch of the same or separate repository using the playbook provider.

Check out the Gradle Antora Plugin to find the complementary plugin for Gradle-based projects.