npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

md-link-check

v1.1.1

Published

A command-line program to check link status in .md files.

Downloads

12

Readme

.md Files Link Validation

That is my first Node.JS library. It is a simple command-line program which receives a .md file path as parameter and validate each link in the file, if it has any. If, instead of passing a file path, the user pass a directory path, it will validate each link of each .md file in the directory. The output is formatted by default as a list to allow for a better visualization in the command-line:

Default output:

Links validation results:

File name: file1.md Link placeholder: {link_placeholder} ⎆ Status: 200 - OK

Link placeholder: {link_placeholder} ⎆ Status: 404 - Not Found

Link placeholder: {link_placeholder} ⎆ Status: Error ⎆ Status: ENOTFOUND

File name: file2.md Link placeholder: {link_placeholder} ⎆ Status: 200 - OK

Link placeholder: {link_placeholder} ⎆ Status: 301 - Moved Permanently

...but it can also output in JSON format passing the "-j" or "--json" flag:

JSON output model:

[
  {
    "filename": "file1.md",
    "links": [
      {
        "id": 1,
        "placeholder": "<link_placeholder>",
        "url": "https://link1.com.br",
        "status": "200 - OK"
      },
      {
        "id": 2,
        "placeholder": "<link_placeholder>",
        "url": "https://link2.com",
        "status": "200 - OK"
      },
      {
        "id": 3,
        "placeholder": "<link_placeholder>",
        "url": "https://link2.com",
        "status": "404 - Not Found"
      }
    ]
  },
  {
    "filename": "file2.md",
    "links": [
      {
        "id": 1,
        "placeholder": "<link_placeholder>",
        "url": "https://link1.com.br",
        "status": "200 - OK"
      },
      {
        "id": 2,
        "placeholder": "<link_placeholder>",
        "url": "httpslink2.com",
        "status": "Error",
        "errorCode": "ERR_INVALID_URL"
      }
    ]
  }
]

If you have any suggestions of improvement, please contact me, I'll be really thankful! :)