raulingg / md-links

find and verify links within markdown files easily.

🔗 Markdown Links

an implementation of Md Links project

Features

• Finds links in a markdown file (.md | .markdown)
• Finds links in a folder recursively.
• Validate links by making a HTTP GET request and checking the response's status code.
• Runs from CLI

---

Installing

• globally

  npm install -g @raulingg/md-links`

• locally, as dependency in your project

  npm install @raulingg/md-links

---

Using

In a project

Requiring commonjs module

const mdLinks = require('@raulingg/md-links')

mdLinks('path/to/file.md')
  .then(mdlink => {
    // Return an object with two methods data and stats

    // data() return an array with results
    mdlink.data().forEach(item => {
      console.log(item.path, item.href, item.text)
    })
  });

// find links in all markdown files inside a directory
mdLinks('path/to/directory').data().then(data => {});

Importing ES module

import mdLinks from require('@raulingg/md-links')

const mdlink = await mdLinks('path/to/file.md')
const results = mdlink.data()

// do whatever you want

validating broken links

mdLinks('path/to/file.md', { validate: true}).then((mdlink) => {
  mdlink.data().forEach((item) => {
    console.log(item.path, item.text, item.href, item.status, item.statusCode)
  })
});

Getting stats

/**
 * Stats Object
 * {
 *    total: <#linksFound>
 *    unique: <#LinksUnique>
 *    broken: <#LinksBroken>
 * }
 */
mdLinks('path/to/file.md').then(mdlink => mdlink.stats());

// get stats from broken links
mdLinks('path/to/file.md', { validate: true}).then(mdlink => mdlink.stats());

---

CLI

Get links

# single file
md-links <path/to/file.md>

# scan all markdown files in a folder
md-links <path/to/dir>

Validate links

md-links <path/to/dir> --validate

Get stats

md-links <path/to/dir> --stats

# validate and return stats
md-links <path/to/dir> --validate --stats

Markdown file

Extensions supported

• .md, .markdown

Format supported

Basic Cases

[valid link](http://test.com)
[[email protected]](http://test.com/test-link?djdjd&)
[title (parenthesis)](http://www.test.com)
[title with
linebreak](http://test.com)

Extra Cases

[[extra sq bracket](https://test.com?g=154&fh=!445?)

Video Case

[![Solution Temperature converter](https://i.ytimg.com/vi/Ix6VLiBcABw/0.jpg)](https://www.youtube.com/watch?v=Ix6VLiBcABw)

Unsupported Cases

[extra sq bracket - invalid]](https://test.com)

[link with linebreak - invalid](http:
//test.com)