Page History

...

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).

There is not yet support for orphan checking (all pages are referenced in a nav), but the Antora community is working on support for extensions and one of the first use cases they want to document as an example is this sort of validation, so it's likely there will be some way to do this within Antora soon.

Family Directories

Asciidoc files are always stored in the pages  family directory. Images should be in the images  family directory.

...

This poses a problem for the Ref Guide, as we have several code examples (particularly for SolrJ, but also others) that pull from real tests which are not located in the Ref Guide directory tree.

However, with Antora 3.0 symbolic links will be supported, so this provides a workaround. In the branch linked above I have tested this out and it works well, although we should test various dev systems to be sure the ones created on my OS work in other OS's (particularly Windows).

Build Options

By default build output is in antora_home, which is the location of the playbook.yml file.

...