First official version

V1.1

This release makes the action available on the marketplace. With it, you can search for dead links in your documentation quickly and efficiently.

Check HTML Links Action

Check HTML Links Github Action

This action checks whether there are any dead links in the documentation of your repository. Based on check-html-links from Modern Web.

This action will run in a folder with html as well as static assets. In other words, that comes after your Jekyll, Yarn, or any other compilation step.

Note: Does not test external links, only internal ones :).

Latest version : V1

Inputs

doc-folder

Optional The location of the documentation folder. Default "dist".

Outputs

result

The complete console output of the folder

Example usage

Snippet

uses: modernweb-dev/check-html-links-action@v1
with:
  doc-folder: '_site'

Here is a complete Example workflow that will check the result of the folder _dist in the root of your repository on each push:

on: [push]

jobs:
  check_html_links_job:
    runs-on: ubuntu-latest
    name: A job to test check-html-links-action
    steps:
    - uses: actions/checkout@v2
    - name: check-html-links-action step
      id: check-links
      uses: modernweb-dev/check-html-links-action@v1
      with:
        doc-folder: 'test-site'

Tests

See test repository and latest status here.

LICENSE

MIT

Author

Modern Web