You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
GitHub Action
MDX Broken Link Checker
0.0.5
Maintained fork of hashicorp/gh-action-check-broken-links, updated with modern tooling.
A GitHub Action that reports all broken links found within a set of provided .mdx
files
⚠️ Currently only supports.mdx
files⚠️ Assumes a Next.js project structure (i.e. links resolve from the/pages
directory)
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.
- name: HashiCorp's Link Checker
uses: hashicorp/gh-action-check-broken-links@v1
with:
# Required: The base URL to check links against
# For example: /pages/foo.mdx will be checked against https://hashicorp.com/foo
baseUrl: 'https://hashicorp.com'
# Optional: Provide a list of files to check
files: 'pages/foo.mdx pages/bar.mdx'
whitelist: |
https://google.com/whitelist
https://yahoo.com/whitelist