Sample

  • check-links.yml
      name: Check Markdown links
    
      on: push
    
      jobs:
        check-links:
          runs-on: ubuntu-latest
            
          steps:
          - name: Checkout 
            uses: actions/checkout@master
              
          - name: Check Markdown links
            uses: gaurav-nelson/github-action-markdown-link-check@v1
    

Example of configured use:

steps:
  - name: Check Markdown links
    uses: gaurav-nelson/github-action-markdown-link-check@v1
    with:
      use-quiet-mode: 'yes'
      use-verbose-mode: 'yes'
      config-file: 'mlc_config.json'
      folder-path: 'docs/markdown_files'
      max-depth: 2