How to checks all Markdown files in your repository for broken links

A GitHub Action — Markdown link check automates your documentation

If you are working on the documentation this GitHub workflow action will help you a lot to check all the broken URL’s in your markdown file.

Introducing GitHub Workflow Action — Markdown Link Check

This Markdown link check helps you to check all the dead links in your GitHub markdown file.

Checking all the links are working or not is the purpose of this action developed by the Gaurav-nelson, let’s see how to implement this into your repository.

Photo by Yancy Min on Unsplash

1. Create a new file in your repository .github/workflows/action.yml.
2. Copy-paste the following workflow in your action.yml file:

It is that simple…

When every time pushes your code to your working repository it will automatically check your all links are live or not, if there is any broken link it will return you 404 link damaged in your action tab.

C-DAC-Notes action by Shreeshailaya

Here you can see the 404 error action click here

C-DAC-Notes action by Shreeshailaya

More about Markdown Link Check

• Here are the real-life usage samples — netadata, GoogleChrome/lighthouse.
• This action uses tcort/markdown-link-check for checking links.