Skip to content

antora site gen github action

License

Notifications You must be signed in to change notification settings

kameshsampath/antora-test-site

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

30 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Antora Demo Site and Playbook Project

This is the playbook project for the Antora demonstration site.

To generate the demo site using this playbook project and the demo documentation components, you’ll need to install the Antora CLI and default site generator.

Playbook

An Antora playbook is responsible for generating a documentation site. It contains the instructions a user wants to relay to an Antora site generator pipeline. 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

Once you’ve installed Antora and saved the demo playbook (antora-playbook.yml) to a local directory, you’re ready to run Antora.

Copyright © 2017-2019 OpenDevise Inc. and individual Antora Project contributors.

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.

About

antora site gen github action

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published