Camptocamp’s Antora Site GitHub Action

GitHub action that can be used to generate the Antora site.

This project is a fork of kameshsampath/antora-test-site.

Parameters

The action has only two parameters:

• antora_playbook — that specifies the Antora playbook path within the repository

• site_sources_path — the path within $GITHUB_WORKSPACE from where to run the site generation

• antora_generator — Select antora generator for site

• antora_search_bar — Flag for enabling antora search bar

Select generator to be used, either: "@antora/site-generator-default" or "antora-site-generator-lunr"'

How to add to your action

name: "Generate site using antora site action"
uses: fsismondi/antora-site-action@master
with:
    antora_playbook: antora-playbook.yml
    # optional path within the repo, defaults to ${{github.workspace}}
    site_sources_path: 'site-sources-folder'
    antora_search_bar: 'true'
    antora_generator: 'antora-site-generator-lunr'