Skip to content
anchor

GitHub Action

MDX Broken Link Checker

0.1.2 Latest version

MDX Broken Link Checker

anchor

MDX Broken Link Checker

Report broken links found in a given set of files

Installation

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

              
- name: MDX Broken Link Checker

              
  uses: KaiSpencer/[email protected]
Learn more about this action in KaiSpencer/gh-action-check-broken-links

Choose a version

Link Checker

Maintained fork of hashicorp/gh-action-check-broken-links, updated with modern tooling.

CI Status GitHub Release

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

  • ⚠️ Currently only supports .mdx files

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

- name: MDX Broken Link Checker
  uses: KaiSpencer/gh-action-check-broken-links@v0
  with:
    # Required: The base URL to check links against
    # For example: /pages/foo.mdx will be checked against https://mysite.com/foo
    baseUrl: 'https://mysite.com'

    # Optional: Provide a list of files to check
    files: 'pages/foo.mdx pages/bar.mdx'
    
    # Optional: Provide a directory to check for files
    # Will recurse all sub directories
    directory: 'pages'

    # Optional: Provide a list of URLs to whitelist
    # These URLs will not be checked
    whitelist: |
      https://google.com/whitelist
      https://yahoo.com/whitelist