Pages Directory and Page Files

Pages family directory

A module directory can contain an optional family directory named pages. Only AsciiDoc source files with the file extension (.adoc) should be stored in the pages directory because Antora applies preset behavior to these files when it runs.

📂 modules
  📂 a-named-module (1)
    📂 pages (2)
      📄 a-source-file.adoc (3)
  📂 ROOT
    📂 pages
      📄 a-source-file.adoc
    📄 nav.adoc

1	A named module directory
2	pages family directory
3	AsciiDoc source file with valid .adoc file extension

A pages family directory must contain at least one AsciiDoc source file.

Pages

Pages are source files stored in a pages directory. Each page is automatically converted to HTML and published as an individual page in a site. Valid pages are marked up using AsciiDoc and saved with the .adoc file extension. Antora uses the filename of each page file as the page segment in its URL.

A page can be cross referenced by any other page, regardless of the component version or module it’s assigned to, using the AsciiDoc xref macro and the page’s page ID.