Vale for VSHN

This project generates a ready-to-use installation of the vale, a "syntax-aware linter for prose built with speed and extensibility in mind."

This image is geared specifically to verify Asciidoc files using the Microsoft, Openly and built-in Vale text style rules. It contains:

• vale

• Microsoft style rules

• Openly style rules

• Asciidoctor

Usage

Use it as follows, for example on an Antora project root, to verify all Asciidoc files in that folder:

podman run --rm --volume "${PWD}"/src/modules/ROOT/pages:/pages --workdir /pages ghcr.io/vshn/vale:2.15.5 --minAlertLevel=error .

Release

To release a new version, create a new tag and push it to GitHub. Ideally the tags follow the vale version contained in the image.

To automatically create a new signed tag with the current vale version, run:

./tag-release.sh