sharonhq
v1.0.4
Published
This module checks the links contained and reports statistics of markdown files
Downloads
4
Maintainers
Readme
Table of Contents
About The Project
This module extracts all the links that are in a markdown file, it has two 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.
Flowchart
Implementation Board
Getting Started
Installation
- 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
Project Link: https://github.com/SharonHQ/LIM013-fe-md-links