GitHub Action - Markdown link check 🔗✔️

This GitHub action checks all Markdown files in your repository for broken links. (Uses tcort/markdown-link-check)

How to use

1. Create a new file in your repository .github/workflows/action.yml.

2. Copy-paste the following workflow in your action.yml file:

   name: Check Markdown links
   
   on: push
   
   jobs:
     markdown-link-check:
       runs-on: ubuntu-latest
       steps:
       - uses: actions/checkout@master
         with:
           fetch-depth: 1
       - uses: gaurav-nelson/github-action-markdown-link-check@0.5.0
   

3. Or you can use the action with variables as follows:

   name: Check Markdown links
   
   on: push
   
   jobs:
     markdown-link-check:
       runs-on: ubuntu-latest
       steps:
       - uses: actions/checkout@master
         with:
           fetch-depth: 1
       - uses: gaurav-nelson/github-action-markdown-link-check@0.5.0
         with:
           use-quiet-mode: 'yes'
           use-verbose-mode: 'yes'
           config-file: 'mlc_config.json'
           folder-path: 'docs/markdown_files'
   

Available variables

• use-quiet-mode: Specify yes to only show errors in output.
• use-verbose-mode: Specify yes to show detailed HTTP status for checked links.
• config-file: Specify a custom configuration file for markdown-link-check. You can use it to remove false-positives by specifying replacement patterns and ignore patterns.
• folder-path: By default the github-action-markdown-link-check action checks for all markdown files in your repository. Use this option to limit checks to only specific folders.

Test internal and external links

www.google.com

This is a broken link

This is another broken link but its ignored using a configuration file.

Alpha

This exists. This one does not. References and definitions are checked too.

Bravo

Headings in readme.md are not checked. But missing files are reported.

External file: Charlie