This repository contains the playbook project for an Antora documentation site published at https://menou.fr/notes.
To generate the Notes site, you first need to install Antora.
Once Antora is installed, run the antora command on the playbook file hosted in this repository.
$ npx antora antora-playbook.yml
The first time Antora runs, it caches any remote content sources git repositories and UI bundles. On subsequent runs, Antora resolves these resources in the cache folder, effectively running offline. You can tell Antora to refresh the cache by setting the fetch option.
$ npx antora --fetch antora-playbook.yml
To use local content repository, antora permits the value of url to be a relative or absolute filesystem path.
sources:
- url: ../notes
branches: HEAD
start_path: docs
The site will be generated into build/. Navigate to build/index.html in your browser to view the site offline.
Antora is designed to create sites that run anywhere, whether it be on a static web host or the local filesystem. However, some hosts offer “features” that mess with Antora’s output. GitHub Pages is one of those hosts.
This site is hosted on GitHub Pages.
Deployment is triggered by a push on the main branch of the git repository and repository dispatch event. The default GITHUB_TOKEN does not have scopes to do this so a repo scoped PAT created on a user with write access to the target repository is required. If you will be dispatching to a public repository then you can use the more limited public_repo scope.
The deploy job is configured by the file publish.yml.
All files are released under the MIT license. See LICENSE to view the full license text.