Partials Directory and Partial Files

Partials family directory

A module directory can contain an optional family directory named partials.

📂 modules
  📂 ROOT
    📂 pages
      📄 a-source-file.adoc
    📂 partials (1)
      📄 a-source-file.adoc (2)
    📄 nav.adoc
1 A partials family directory in a ROOT module directory
2 A partial source file

Antora applies preset behavior to the source files stored in the partials directory when it generates a site.


Partials are resources that contain content snippets, such as common descriptions, terminology, or reference tables, that you plan to reuse in one or more pages. Partials are saved as AsciiDoc source files (.adoc) and stored in a partials directory.

If a partial isn’t referenced in an AsciiDoc include directive, its content won’t be published to a site. Partials and tagged regions in a partial can be inserted into any page, regardless of the module or component version that page belongs to, using the include directive and the partial’s resource ID.

When referencing a partial, the partial$ family coordinate must be included in its resource ID. This coordinate is required because the include directive is also used to reference examples and, occasionally, pages.