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-links-catin

v0.1.0

Published

* [1. Preámbulo](#1-preámbulo) * [2. Resumen del proyecto](#2-resumen-del-proyecto) * [3. Objetivos de aprendizaje](#3-objetivos-de-aprendizaje) * [4. Consideraciones generales](#4-consideraciones-generales) * [5. Consideraciones técnicas](#5-consider

Downloads

1

Readme

Markdown Links


Descripción

Md-Links es una librería en Node.js diseñada para analizar enlaces dentro de archivos [Markdown], ya sea proporcionandonos la validación de los enlaces, el estado de estos enlaces y la estadistica para mejor analisis.

Instalación

Como primer requisito debes tener instalado Node.js. Para instalar la librería md-links utilizando NPM (Node Package Manager):

  1. Ejecuta el siguiente comando en tu terminal:

npm i md-links-catin

  1. Uso:
  • Para leer un archivo markdown y extraer sus enlaces escribe md-links seguido de la ruta del archivo.
`md-links <path-to-file> [options]`

Por ejemplo:

mdlinks-example

El comportamiento por defecto no debe validar si las URLs responden ok o no, solo debe identificar el archivo Markdown (a partir de la ruta que recibe como argumento), analizar el archivo Markdown e imprimir los links que vaya encontrando, junto con la ruta del archivo donde aparece y el texto que hay dentro del link.

Options

--validate

Si pasamos la opción --validate, el módulo debe hacer una petición HTTP para averiguar si el link funciona o no. Si el link resulta en una redirección a una URL que responde ok, entonces consideraremos el link como ok.

Por ejemplo:

mdlinks-example-validate

Vemos que el output en este caso 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.

--stats

Si pasamos la opción --stats el output (salida) será un texto con estadísticas básicas sobre los links.

mdlinks-example-stats

También podemos combinar --validate y --stats para obtener estadísticas que necesiten de los resultados de la validación.

Diagrama de Flujo

Acontinuación, verás un diagrama de flujo, para entender el proceso de md-links.

  • Diagrama de flujo