https://github.com/hashicorp/gh-action-check-broken-links

A GitHub Action that checks for the presence of broken links
https://github.com/hashicorp/gh-action-check-broken-links

Last synced: 3 months ago
JSON representation

A GitHub Action that checks for the presence of broken links

• Host: GitHub
• URL: https://github.com/hashicorp/gh-action-check-broken-links
• Owner: hashicorp
• License: mpl-2.0
• Archived: true
• Created: 2020-05-13T02:00:13.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-09-25T16:25:58.000Z (about 1 year ago)
• Last Synced: 2024-03-15T00:03:36.659Z (8 months ago)
• Language: TypeScript
• Size: 1.37 MB
• Stars: 49
• Watchers: 7
• Forks: 9
• Open Issues: 20
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# HashiCorp's Link Checker

![C/I Status](https://github.com/hashicorp/gh-action-check-broken-links/workflows/C/I/badge.svg)

A GitHub Action that reports all broken links found within a set of provided `.mdx` files

- :warning: Currently only supports `.mdx` files

- :warning: Assumes a Next.js project structure (i.e. links resolve from the `/pages` directory)

## Features

Parses `.mdx` files, locating all links. Reports back any failed requests including those that contain a fragment identifier (i.e. https://example.com/page#identifier) but whose resulting markup does not.

## Example Usage

```yaml

- name: HashiCorp's Link Checker

  uses: hashicorp/gh-action-check-broken-links@v1

  with:

    baseUrl: 'https://hashicorp.com'

    files: 'pages/foo.mdx pages/bar.mdx'

    whitelist: |

      https://google.com/whitelist

      https://yahoo.com/whitelist

```