Check all links in markdown files if they are alive or dead. 🔗✔️
Go to file
2020-01-27 15:48:16 +01:00
.github/workflows Upgraded to new yml syntax 2019-08-28 09:12:06 +10:00
action.yml Updated action.yml 2019-10-09 11:43:48 +10:00
Dockerfile Update Dockerfile 2020-01-27 15:48:16 +01:00
entrypoint.sh Added support for markdown-link-check config file 2019-10-09 10:53:02 +10:00
LICENSE Initial commit 2019-03-30 21:54:25 +10:00
mlc_config.json Added support for markdown-link-check config file 2019-10-09 10:53:02 +10:00
README.md Fix typo 2019-10-11 14:08:50 +02:00

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.

www.google.com

This is a broken link

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