Skip to content
check

GitHub Action

HTMLProofer

v2 Latest version

HTMLProofer

check

HTMLProofer

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

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: HTMLProofer

              
  uses: chabad360/htmlproofer@v2
Learn more about this action in chabad360/htmlproofer

Choose a version

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.

⭐ Getting Started

This is just a portion of a workflow.yml to get you started (for more information scroll down to ⭐ Inputs):

...
      - 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 for more details) ❌ N/A

Usage

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