md-links-nvn

Markdowns Links

Installation

$ npm install --save md-links-nvn

$ npm install -g https://github.com/NatalyVerdugoNogue/scl-2018-01-FE-markdown 

Executable configuration

$ npm run config 

Importing

import mdLinks from 'md-links-nvn'; // ES6
var mdLinks = require('md-links-nvn'); // ES5 with npm

Description

When writing the path of a reduction file, and if it contains links, depending on the options entered, the links, the line and the text of all the links in the file will be displayed.

Usage

md-links <path-to-file> [options]

Examples

Show:

md-links <path-to-file>
[ '(path): (line) (link) (text-link)' ]

Example:

md-links file-test.md
[ '/home/user/dir/file-test.md: 1 https://nodejs.org/ Node.js' ]

 

Options

--validate

Show:

md-links <path-to-file> --validate
[ '(path): (line) (link) (text-status) (status-code) (text-link)' ]

Example:

md-links file-test.md --validate
[ '/home/user/dir/file-test.md: 1 https://nodejs.org/ OK 200 Node.js' ]

 

--stats

Show:

md-links <path-to-file> --stats
(path): {Total: (num), Unique: (num)}

Example:

md-links file-test.md --stats
/home/user/dir/file-test.md { Total: 1, Unique: 1 }

Tests

Clone of git

$ npm test 

Version

1.0.1

License

ISC

npm

npm

Action plan

Trello

Author

• Nataly Verdugo