vshn / antora

Antora Docker image used internally at VSHN.

Custom Antora Image

This repository builds an extended Antora container image, used to build documentation projects at VSHN.

It is based on the information provided in the Antora documentation.

Usage

Use the following commands on the root of an Antora project. In both cases you should have an output folder with the documentation following the instructions in the playbook.yml file.

Podman

podman run --rm --volume "${PWD}":/antora ghcr.io/vshn/antora:${VERSION} playbook.yml --cache-dir=.cache/antora

Docker

docker run --rm --user="$(id -u)" --volume "${PWD}":/antora docker.io/vshn/antora:${VERSION} playbook.yml --cache-dir=.cache/antora

If you don’t specify the --user parameter, Docker will create output folders belonging to root.