Getting Started
To run this project locally, you need to use Antora.
Running Antora
Run the following command in the root directory of your project:
npx antora antora-playbook.yml
This command will generate the site in the build/site directory.
Open build/site/index.html in your browser to view it.
Managing Versions
Antora is configured to look at the HEAD (your current working branch) and any branches named v1. or v2..
To create a new documentation version (for example, for release 1.0):
1. Create a new git branch: git checkout -b v1.0
2. Update the version: key in docs/antora.yml on that branch to '1.0'
3. Commit the changes and push the branch.
4. When you generate the site, Antora will automatically build both versions and provide a version selector in the UI!