An open API service indexing awesome lists of open source software.

https://github.com/chabad360/htmlproofer

🚀 Test your rendered HTML files to make sure they're accurate. 🚀
https://github.com/chabad360/htmlproofer

actions htmlproofer workflow

Last synced: 11 months ago
JSON representation

🚀 Test your rendered HTML files to make sure they're accurate. 🚀

Awesome Lists containing this project

README

          



GitHub Actions for HTMLProofer




gjtorikian/HTMLProofer: Test your rendered HTML files to make sure they're accurate.




🚀

License


Release


Release

🚀



If you're generating HTML pages, you might want to use it.



 

This action will test your site using [HTMLProofer](https://github.com/gjtorikian/html-proofer).

## ⭐ Getting Started

This is just a portion of a `workflow.yml` to get you started (for more information scroll down to [⭐ Inputs](#-inputs)):

```yml
...
- name: Check HTML
uses: chabad360/htmlproofer@master
with:
directory: "./public"
```

### ⭐ Inputs

| Key | Description | Required | Default |
| --- | ------------ | :------: | ------- |
| `directory` | The directory to scan. | ✔️ | N/A |
| `arguments` | The arguments to pass to HTMLProofer (see [here](https://github.com/gjtorikian/html-proofer#configuration) for more details) | ❌ | N/A |

#### Usage

```yml
...
- name: Check HTML
uses: chabad360/htmlproofer@master
with:
directory: "./public"
# The directory to scan
arguments: --allow-missing-href
# The arguments to pass to HTMLProofer
```