0.1.6 • Published 5 years ago
md-links-de-vale v0.1.6
Markdown Links
mdLinks.js
Library to extract linkages from markdown documents
Installation
Install using npm
$ npm install md-links-de-vale
Importing
You can also import it using require
let mdLinks= require('md-links-de-vale');
Uso
mdLinks (path,options); can accept absolute or relative routes. Accepts files or directories with .md extension
Executable
md-links <path-to-file> [options]
Examples
$ md-links ./some/example.md
./some/example.md http://algo.com/2/3/ Link a algo
./some/example.md https://otra-cosa.net/algun-doc.html algún doc
./some/example.md http://google.com/ Google
Future versions
Options
--Validate
to find out if the link works or not. output:incluye la palabra ok o fail después de la URL, así como el status de la respuesta recibida a la petición HTTP a dicha URL.
$ md-links ./some/example.md --validate
./some/example.md http://algo.com/2/3/ ok 200 Link a algo
./some/example.md https://otra-cosa.net/algun-doc.html fail 404 algún doc
./some/example.md http://google.com/ ok 301 Google
--stats
Output: will be a text with basic statistics about the links.
$ md-links ./some/example.md --stats
Total: 3
Unique: 3
--Validate
--stats
To obtain statistics that need validation results.
$ md-links ./some/example.md --stats --validate
Total: 3
Unique: 3
Broken: 1
If you want to collaborate with my repository
GitHub https://github.com/valeskaperezrretamal/SCL008-md-links