https://github.com/vshn/antora
Antora Docker image used internally at VSHN.
https://github.com/vshn/antora
vshn-project-ignore
Last synced: about 2 months ago
JSON representation
Antora Docker image used internally at VSHN.
- Host: GitHub
- URL: https://github.com/vshn/antora
- Owner: vshn
- Created: 2019-10-07T14:24:18.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-04-08T16:45:43.000Z (about 2 months ago)
- Last Synced: 2025-04-09T17:13:21.256Z (about 2 months ago)
- Topics: vshn-project-ignore
- Language: Dockerfile
- Homepage:
- Size: 85 KB
- Stars: 3
- Watchers: 3
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.adoc
Awesome Lists containing this project
README
= Custom Antora Image
This repository builds an extended https://antora.org/[Antora] container image, used to build documentation projects at VSHN.
It is based on the information provided in the https://docs.antora.org/antora/2.1/antora-container/[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
[source,bash]
--
podman run --rm --volume "${PWD}":/antora ghcr.io/vshn/antora:${VERSION} playbook.yml --cache-dir=.cache/antora
--
=== Docker
[source,bash]
--
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`.