THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
...
Docs: https://docs.antora.org/antora/2.3/
Cassandra's branch: https://github.com/ctargett/solr/tree/antora-migration/solr/solr-ref-guide
| Table of Contents |
|---|
Antora Design Goals
...
A sitemap is automatically built.
The playbook can reference repos that are local or in GitHub or GitLab, etc. Specific branches can be built or use HEAD for whatever branch is checked out at that time.
Component
All projects have at least one component, defined by an antora.yml file stored at the "content root". Its presence indicates to Antora that it should find content files in this location (organized under a modules directory). The antora.yml file must include a name, but can also include a version.
The idea is there would be one of these for each version of the software, so a different one on each branch.
...
If we chose to organize the Ref Guide into modules we'd come up with a directory structure that looked looks something like this (not final, just an early example - see below for family directory infonecessarily final):
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.
...