This Getting Started is a small guide to setup your own Docs Page using Antora and GitHub Pages. This will be pretty basic. If you are looking for more information feel free to visit the Antora Docs .

There are four parts to do

1. Basic Overview

To build your html docs page with Antora you need a GitHub Repository and a Playbook Project where the docs will be created.

Antora will fetch the necessary files (antora.yml, adoc files ..) out of your Playbook Project and create a html Site out of it.

In this Guide we are going to have The Playbook Project inside the Repository for better traceability.

GitHub Pages will be used to serve our created example docs.

and now .. get started!