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-minder

v1.0.1

Published

Verificar el estado de los enlaces

Downloads

7

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

sara_stefaniasara_stefania

Keywords

javascriptnode.jsCLI

Readme

Markdown Links

Índice

1. Preámbulo

Markdown es un lenguaje de marcado ligero muy popular entre developers. Es usado en muchísimas plataformas que manejan texto plano (GitHub, foros, blogs, ...) y es muy común encontrar varios archivos en ese formato en cualquier tipo de repositorio (empezando por el tradicional README.md).

Estos archivos Markdown normalmente contienen links (vínculos/ligas) que muchas veces están rotos o ya no son válidos y eso perjudica mucho el valor de la información que se quiere compartir.

Dentro de una comunidad de código abierto, nos han propuesto crear una herramienta usando Node.js, que lea y analice archivos en formato Markdown, para verificar los links que contengan y reportar algunas estadísticas.

2. Resumen del proyecto

mdLinks es una libreria creada con NodeJS que permite verificar el estado de los enlaces que se encuentran en un archivo Markdown.

Esta biblioteca es útil para verificar si algunos de nuestros enlaces están repetidos, rotos o son inválidos.

3. Instalación

$ npm i md-links-minder

4. Comandos

Accede a la terminal y ejecuta el comando

$ md-links --help

Te mostrará las instrucciones para seguir y podrás conocer todas las opciones y argumentos disponibles para utilizar la herramienta.

Ejemplo

$ md-links --help

comando --help

El segundo paso es incertar la ruta a validar: md-links ./path-a-evaluar.md

Sólo colocando la ruta obtendremos un arreglo de objetos con las propiedades:

Href: URL encontrada.

Text: Texto que aparecía dentro del link ().

File: Ruta del archivo donde se encontró el link.

Ejemplo

path

Opciones

Comando --Validate

$ md-links <path> --validate

Obtendrás el estado de los enlaces de tus archivos

Ejemplo

comando validate

Comando --stats

$ md-links <path> --stats

Obtendrás las estadísticas del total de enlaces y los enlaces únicos

Ejemplo

comando stats

Comando --validate --stats

$ md-links <path> --validate --stats

Obtendrás las estadísticas de los enlaces rotos

Ejemplo

comando stats

Asegurese de ingresar una ruta valida que contenga archivos tipo Markadown