md-links-thatmare

Table of Contents

• 1. Description
• 2. Install
• 3. Usage

---

1. Description

md-links-thatmare is a library and a command-line interface to analyze the links in Mardown files. This project was developed with Node.js filesystem and Axios.

With this package you're able to:

• Identify links.
• Validate links HTTP status.
• Get statistics about the links.

Check the npm package published here

2. Install

If you already have Node, just run npm install md-links-thatmare.

If you want to use it as a library, require the module mdLinks.

3. Usage

• md-links --help To print the usage instructions:

• md-links <path> You can analyze files or directories with a relative or absolute path.

• md-links <path> --validate Gives you the HTTP status and message.

• md-links <path> --stats Counts the total and unique links.

• md-links <path> --stats --validate Counts the total, unique and broken links.