https://github.com/mgwalker/action-htmlproofer

GitHub Action for running htmlproofer
https://github.com/mgwalker/action-htmlproofer

Last synced: about 1 month ago
JSON representation

GitHub Action for running htmlproofer

• Host: GitHub
• URL: https://github.com/mgwalker/action-htmlproofer
• Owner: mgwalker
• License: mit
• Created: 2022-12-20T15:08:28.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2022-12-20T20:33:21.000Z (about 2 years ago)
• Last Synced: 2024-04-15T01:57:13.787Z (9 months ago)
• Language: Shell
• Size: 5.86 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# htmlproofer

This action runs [htmlproofer](https://github.com/gjtorikian/html-proofer) on

HTML files. If there are any identified errors, it will convert them into

annotations to make them easier to read in the test output.

Currently using htmlproofer 5. For configuration arguments, see the

[htmlproofer configuration](https://github.com/gjtorikian/html-proofer#configuration)

documentation. Note that the options listed on that page should be prefixed with

two dashes, and underscores should be replaced with dashes. E.g., the

`allow_missing_href` option would become `--allow-missing-href` when using this

action.

## Usage

```yaml

- uses: mgwalker/action-htmlproofer@v1

  with:

    # The path in your repository to scan for HTML files. In order to ensure

    # this path is present, be sure to checkout the repository before running

    # this action. Defaults to "."

    path: "_pages"

    # Any additional argumets to pass into htmlproofer.

    args: "--disable-external --allow-missing-href"

```