Antora Demo Site and Playbook Project

This is the playbook project for the Antora demo site. You can view the site produced by the Antora playbook (antora-playbook.yml) stored in this project at https://antora.gitlab.io/demo/docs-site.

You can also use this project and the demo documentation components to generate the demo site on your own computer To use the demo materials and generate the demo site locally, follow the steps in the Antora quickstart.

Antora Playbook

An Antora playbook is responsible for generating a documentation site. It contains the instructions a user wants to relay to the Antora site generator. These instructions include the content Antora should collect and the UI it should apply to the generated site.

The file antora-playbook.yml in this repository is the playbook used to produce the demo site. It tells Antora where to find the Component A and Component B remote content repositories and default UI.

Generate the Demo Site

After cloning this playbook project repository to your computer or setting up your own playbook for the demo site (see the Antora quickstart for instructions) you can generate the demo site by running Antora.

Copyright © 2017-present by OpenDevise Inc. and the individual contributors to Antora.

Use of this software is granted under the terms of the Mozilla Public License Version 2.0 (MPL-2.0). See LICENSE to find the full license text.

Authors

Development of Antora is led and sponsored by OpenDevise Inc.