mg-links
v0.1.1
Published
A command line tool for which reads and parses Markdown files, to verify the links they contain and to report some statistics.
Downloads
4
Maintainers
Readme
* * MG-LINKS * *
It is a library that allows you to validate URLs inside markdown files. It will allow you to obtain: link status, total links, unique links and broken links.
Getting started 🚀
These instructions will allow you to install the library on your local machine for development.
See Deployment for the library developed with Node.js.
Installation 🔧
You can install it by npm:
$ npm i mg-links
Guide to use ⚙️
You can run the library through the terminal:
mg-links <path-to-file> [options]
The paths entered can be relative or absolute and the options you can use are: --help or -h
, --stats or -s
, --validate or -v
, or use both together --stats --validate or -s -v
.
Case 1: mg-links <path-to-file>
Case 2: mg-links <path-to-file> --validate
Case 3: mg-links <path-to-file> --stats
Case 4: mg-links <path-to-file> --stats --validate
or md-links <path-to-file> --validate --stats
Case 5: mg-links --help
Case 6: When information is omitted or incorrect
Case 7: mg-links <path-to-directory>
Flowcharts
API-flowchart
CLI-flowchart
Test ✅
Built with 🛠️
- Node.js - Used to create the library
- NPM - Manage packages
- Figlet - Generate banner
- Chalk - Used to style terminal output
- CommonJS - Handle modules
- node-fetch - Make HTTP calls
- Jest - Testing