sharonhq

<SharonHQ>/md-links

Table of Contents

• About the Project
• Flowchart
• Implementation Board
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Contact

About The Project

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

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

Flowchart

Implementation Board

Getting Started

Installation

1. Install NPM packages

npm i sharonhq

Usage

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

sharonhq md-links <path>

• --validate

sharonhq md-links <path> --validate

• --stats

sharonhq md-links <path> --stats

• --validate --stats

sharonhq md-links <path> --validate --stats

Contact

Sharon

Project Link: https://github.com/SharonHQ/LIM013-fe-md-links