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 folloing 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.4.0
   

3. To use a custom configuration for markdown-link-check, create a JSON configuration file and save it in the root folder as mlc_config.json.

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