govau/html-proofer repository overview

⁠HTML Proofer, Dockerized

HTML validation, made easy. This repository is the HTML Proofer⁠ Ruby gem wrapped up in a Docker container, so you don't have to fuss with installing things like Ruby⁠ or Nokogiri⁠.

⁠Usage

Requires Docker⁠.

docker run 18fgsa/html-proofer

This will print out the usage instructions. Arguments for the htmlproofer CLI⁠ can then be appended to the command. Note that it's not (yet) recommended this be used against live sites due to this issue⁠.

⁠Single file

You will need to mount the file as a data volume⁠ so it's available in the container, like so:

docker run -v /absolute/path/to/file.html:/file.html 18fgsa/html-proofer /file.html

⁠Directory of files

e.g. those created by a static site builder like Jekyll⁠ or Hugo⁠. You will need to mount the directory as a data volume⁠ so it's available in the container, like so:

docker run -v /absolute/path/to/dir/:/site 18fgsa/html-proofer /site

⁠GitLab CI

You can use this image in GitLab CI, just configure job in .gitlab-ci.yml like this:

test:
  image: 18fgsa/html-proofer:gitlab-ci
  script:
    - htmlproofer _site --empty-alt-ignore