...
A special module named ROOT module is optional, but used for pages which have no formal module - like primary navigation pages, index.html
, etc. Pages placed under ROOT do not have any module name in the path.
This module construct means that we will need to change our page-to-page links from a structure like <<pageName.adoc#anchor,Title>>
to xref:module:pageName.adoc#anchor[Title]
. One plus here is that Antora will automatically populate the page title if it's not defined in the xref
, and in 3.0 the build has validation to make sure page references can be resolved (we had to validate this manually with Jekyll).
Family Directories
Asciidoc files are always stored in the pages
family directory. Images should be in the images
family directory.
...