Markdown Links 🔗

Índice

• 1. Md-Links
• 2. Installation
• 3. User guide
• 4. Flowchart
• 5. Backlog
• 6. Author

1. Md-Links

Yes, another library, but different from all the previous ones 📚

MD-LINKS is a library and a command line tool (CLI) executable with Node.js, which allows identifying, validating and obtaining statistics of the URLs contained in format files. Markdown

With MD-LINKS you will be able to read files that contain links (links/links), identify which ones are broken or no longer valid, in order to prevent them from damaging the value of the information you want to share.

2. Installation

$ npm install md-links-yuli

3. User guide

API:

const { mdLinks } = require('md-links-yuli');

If you want to validate the links found in your .md files you can use the { validate: true } property as follows:

Return value:

If you only want to see the links found in your .md files you can change the property to { validate: false }:

Return value:

CLI (Command Line Interface):

md-links <path-to-file>

md-links <path-to-file> --validate or --v

md-links <path-to-file> --stats or --s

md-links <path-to-file> --validate --stats or --v --s

4. Flowchart

5. Backlog

The backlog was implemented with Github Projects

6. Author

Yulimar Duque front-end developer