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

v1.0.0

Published

Interfaz de línea de comando (CLI) que permite validar las URLs en los archivos markdown, recibe una ruta como argumento, analiza el contenido y retorna los estados de las URL encontradas.

Downloads

1

Vulnerabilities

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

Links

Git

Maintainers

briggtte.barbozabriggtte.barboza

Keywords

md-linksmarkdownCLIcommand-line interfacelinkspath

Readme

📎Proyecto: MD-Links

md-links

📍1. Introducción

MD-Links es una librería para JavaScript que le permite al usuario validar las URLs contenidas en los archivos Markdown (.md). Esta librería te permite obtener la ruta (ubicación) de los archivos Markdown, las URLs y sus descripciones; además, determinar el número de enlaces totales, únicos y rotos.

📍2. Instrucciones de uso

Las rutas ingresadas en la terminal pueden ser relativas o absolutas y las opciones que puede usar son: --stats, --validate. Recuerda que también puedes usar ambas al mismo tiempo: --stats --validate.

Instalación

Puedes hacer la instalación por npm:

npm i md-links-brith

Una siguiente forma de poder ejecutar la librería es a través de la terminal, ingresnado md-links seguido de la ruta que se quiere analizar, posteriormente a ello, puedes ingresar las opciones --validate o --stats.

Casos de uso

Primer caso:

md-links <ruta de archivo>

Ejemplo: primer_caso

La información retornada es:

  • href: URL encontrada.
  • text: Texto que acompaña a la URL. (<a>).
  • file: Ruta absoluta de la ubicación de la URL encontrada.

Segundo caso:

md-links <ruta de archivo> --validate

Ejemplo: segundo_caso

La información retornada es:

  • href: URL encontrada.
  • text: Texto que acompaña a la URL. (<a>).
  • file: Ruta absoluta de la ubicación de la URL encontrada.
  • status: Código de respuesta HTTP.
  • message: Mensaje del estado de las URL, fail en caso de fallo u ok en caso de éxito.

Tercer caso:

md-links <ruta de archivo> --stats

Ejemplo: tercer_caso

La información retornada es:

  • Total Links: Número total de URL encontradas.
  • Unique Links: Número de URL encontradas pero con repetición.

Cuarto caso:

md-links <ruta de archivo> --stats

Ejemplo: cuarto_caso

La información retornada es:

  • Total Links: Número total de URL encontradas.
  • Unique Links: Número de URL encontradas pero con repetición.
  • Broken Links: Número de URL encontradas con estado fail.

📍3. Desarrollo

  1. Inicialmente se necesita establecer un diagrama de flujo que permita conocer los procesos que el desarrollador seguirá, se utilizó la herramienta draw.io para diseñar el diagrama de flujo necesario. diagrama-flujo
  2. Node.js - Usado para crear la librería.
  3. npm - Usado para desplegar el módulo.
  4. jest - Usado para ejecutar el testing de las funcionalidades.
  5. chalk - Usado para darle estilos en la información mostrada en la terminal.

📍3. Autora

Briggtte Barboza Nieto