An NPM package to check links in Markdown files.

tcort - markdown-link-check stars - markdown-link-check

Run with GitHub Actions

See GitHub Action Markdown Link Check recipe in the GitHub Actions section.

Run NPM CLI tool

Install

Use -g if you want to install globally.

$ npm install markdown-link-check -D

Run file

You can access the package within a Node script too, but below is just for using the CLI tool.

$ markdown-link-check https://github.com/tcort/markdown-link-check/blob/master/README.md

$ markdown-link-check README.md

Run on directory

You have to set up logic yourself to run it on a directory.

$ find . -name '*.md' -exec markdown-link-check {} \;

Run with container

See the docs.