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

mg-links

v0.1.1

Published

A command line tool for which reads and parses Markdown files, to verify the links they contain and to report some statistics.

Downloads

4

Readme

mglinks_logo

* * MG-LINKS * *

It is a library that allows you to validate URLs inside markdown files. It will allow you to obtain: link status, total links, unique links and broken links.


Getting started 🚀

mglinks_banner

These instructions will allow you to install the library on your local machine for development.

See Deployment for the library developed with Node.js.

Installation 🔧

You can install it by npm:

$ npm i mg-links

Guide to use ⚙️

You can run the library through the terminal:

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

The paths entered can be relative or absolute and the options you can use are: --help or -h, --stats or -s, --validate or -v, or use both together --stats --validate or -s -v.

Case 1: mg-links <path-to-file>

case1


Case 2: mg-links <path-to-file> --validate

case2


Case 3: mg-links <path-to-file> --stats

case3


Case 4: mg-links <path-to-file> --stats --validate or md-links <path-to-file> --validate --stats

case4


Case 5: mg-links --help

case5


Case 6: When information is omitted or incorrect

case6


Case 7: mg-links <path-to-directory>

case7


Flowcharts

API-flowchart

Flowchart API MDLINKS

CLI-flowchart

Flowchart CLI MDLINKS


Test ✅

test


Built with 🛠️

Author ✒️

Mariana Guanda