Check all links in markdown files if they are alive or dead. 🔗✔️
Go to file
Gaurav Nelson 7399cff7db
Merge pull request #4 from gaurav-nelson/support-mlc-config
Added support for markdown-link-check config file
2019-10-09 10:57:03 +10:00
.github/workflows Upgraded to new yml syntax 2019-08-28 09:12:06 +10:00
Dockerfile Check markdown files 2019-04-03 15:16:17 +10: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 Update example version 2019-10-09 10:55:47 +10: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.3.0
    
  3. To use a custom configuration for markdown-link-check, create a JSON configuration file and save it in the root filder as mlc_config.json.

www.google.com

This is a broken link

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