This repository contains an Antora playbook project for building the documentation site for the BBC BASIC (Z80) Manual for the Agon Light.
The documentation site is built using Antora. The content is pulled from the Agon BBC BASIC Manual repository on GitHub. This source is defined in the Antora playbook file, antora-playbook.yml. Each content source points to a folder in one or more branches that is structured as a documentation component, which Antora consumes.
The UI for the site is hosted in a separate repository, asciidoctor-docs-ui.
To generate the Asciidoctor Docs site, you first need to install Antora.
We recommend installing and running the antora command on the playbook file hosted in this repository using npx.
npx installs Antora the antora package globally into an isolated directory, then runs the corresponding antora command.
$ npx antora antora-playbook.yml
If you are having issues with stale, cached content, pass the --fetch flag to pull the latest.
$ npx antora --fetch antora-playbook.yml
To learn more, refer to the installation instructions in the Antora documentation.
The command will generate a site in the build directory which may be viewed offline.
The build directory should not be committed to this repository, and has been included in the .gitignore configuration file.
Asciidoctor is copyright © 2020-present Dan Allen, Sarah White, and individual contributors to the docs.asciidoctor.org repository.
The source and configuration files in this repository are licensed under the terms of the MIT License.
The build for this documentation site sources content the licence for which is still to be agreed.
Unless otherwise noted, the documentation content is licensed under a Creative Commons Attribution 4.0 International License (CC BY 4.0).
Use of the Asciidoctor projects are granted under the terms of each software project’s open source license.
Those licenses include MIT, Apache-2.0, and CC BY 4.0.