/markdown-link-reporter

A cli tool for identifying all broken local markdown links in a file or directory.

Primary LanguageTypeScript

Markdown Link Reporter 📝

A cli tool for identifying all broken local markdown links in a file or directory.

Installation

npm install -g markdown-link-reporter

Usage

After installing, run the command md-report in your terminal. By default, this will scan all markdown files in your current working directory.

To test a specific directory or file, run md-report <relative or absolute path to folder or file>.

Example:

md-report ./Readme.md