md-links

vanesa-md-links is a library that get links from markdown files. Besides basic information about links, where gives statistics and http validation: Total Unique(links) Broken(links)

Index

• 1 Installation
• 2 API
• 3 CLI

1 Installation

Write the command line run bellow to install the module:

npm install vanesa-md-links

2 API

The way to import the library is with require(), and is used in acordance the follow information about the function:

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

Recomendation The only avaible commands are:

--stats
--validate
--stats --validate

Arguments

mdLinks(path, options)

• path: absolute or relative route to the file or directory.
• options: An object with only the following properties:
  • validate: Boolean that determines if links need to be validated.
  • stats: Boolean that determines if you want to obtain an output with general statistical information.

Return Value

It returns a Promise that is resolved with an Array of objects, where every Object represents a link and contains these properties:

With validate:false :

• href: URL that was found.
• text: Text inside the link (<a>).
• file: Files's route where the link was found.

With validate:true :

• href: URL that was found.
• text: Text inside the link (<a>).
• file: Files's route where the link was found.
• status: Response HTTP Code.
• ok: Message fail or ok (if it was successful).

Examples (results as comments):

const {mdLinks} = require("vanesa-md-links");

mdLinks("./some/example.md", { validate: false })
  .then(links => console.log(links)
    // => [{ href, text, file }, ...]
  )
  .catch(console.error);

mdLinks("./some/example.md", { validate: true })
  .then(links => console.log(links)
    // => [{ href, text, file, status, ok }, ...]
  )
  .catch(console.error);

mdLinks("./some/dir", { validate: false })
  .then(links => console.log(links)
    // => [{ href, text, file }, ...]
  )
  .catch(console.error);

mdLinks("./some/dir", { validate: true })
  .then(links => console.log(links)
    // => [{ href, text, file, status, ok }, ...]
  )
  .catch(console.error);

3 CLI

This is the way you can use the executable file by the command line:

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

An example:

$ md-links ./some/example.md
./some/example.md http://something.com/2/3/ Link to something
./some/example.md https://otra-cosa.net/any-doc.html any doc
./some/example.md http://google.com/ Google

Options

--validate

An example:

$ md-links ./some/example.md --validate
./some/example.md http://something.com/2/3/ ok 200 Link to something
./some/example.md https://otra-cosa.net/any-doc.html fail 404 any doc
./some/example.md http://google.com/ ok 301 Google

--stats

An example:

$ md-links ./some/example.md --stats
Total: 3
Unique: 3

Also you can use both --stats and --validate (it does not matter the order).

Examples:

$ md-links ./some/example.md --stats --validate
Total: 3
Unique: 3
Broken: 1

$ md-links ./some/example.md --validate --stats
Total: 3
Unique: 3
Broken: 1