@jenyfermarqez/mq-links v1.0.0

Mq-Links 🔗

1. About The Project ✒️

This module extracts all the links that are in a Markdown file, it has the following options:

--validate: Check if there are valid or broken links --stats: Shows a statistic of the total number of links and how many of them are unique. --validate --stats: Adds to the statistics the total amount of broken links.

2. Getting Started 🚀

Installation 🔧

Install NPM packages

 npm  install @marqez/mq-links

Usage

Case 1:

We will use the md-links command to get the links of the path.

mq-links <path-to-file>

Case 2:

mq-links <path-to-file> --validate 
                 o 
mq-links <path-to-file> --v 

Case 3:

  mq-links <path-to-file> --stats
                  o 
  mq-links <path-to-file> --s 

Case 4:

mq-links <path-to-file> --stats --validate            
                   or 
mq-links <path-to-file> --validate --stats

Case 5:

md-links --help

2. Flowchart

3. Built with 🛠️

• Javascript.
• Node.js.
• Npm.
• Jest.
• ESlint.

Dependencies:

• node-fetch.
• marked.
• jsdom.
• figlet.
• chalk.