Antora components and modules

Open the component structure#

An Antora component commonly contains:

antora.yml
modules/
  ROOT/
    nav.adoc
    pages/
      index.adoc
    partials/
      shared.adoc
    images/

Open the component with its descriptor and modules visible to the IDE. Resource navigation depends on component/version/module context, not only a matching filename somewhere in the repository.

Use resource IDs#

Antora references identify a resource family and context. For example, a page can include a partial:

include::partial$shared.adoc[]

A same-module page reference can use xref:setup.adoc[]; cross-module/component references need the appropriate resource ID. Invoke completion and Go to Declaration to verify the target instead of converting an Antora ID into a filesystem-relative path.

Add a module#

Use Add Antora Module in the appropriate component context. Review the generated resource directories and navigation files. Creating a module locally does not automatically publish it or add every page to the site’s navigation.

Keep component name/version and module identity consistent with the site’s playbook. If another component is fetched during the actual Antora build, local completion may need that content available in the workspace to navigate it.

Respect build context#

Configure project roots and trusted Antora/extension behavior only for content you intend to render. Preview configuration and safe modes affect local file access. A local preview is useful for authoring, while the Antora site build validates full resource collection, component versions, navigation, and extensions.

After moving a page, check inbound xrefs and navigation entries. After renaming a component/version, review resource IDs across consumers rather than only the file you edited.