Socket
Socket
Sign inDemoInstall

md-links-elimendeza

Package Overview
Dependencies
9
Maintainers
1
Versions
2
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    md-links-elimendeza

Md-links es una interfaz de línea de comando (CLI) que facilita la lectura y análisis de archivos con formato Markdown, para generar reportes estadísticos de las URLs encontradas en éstos archivos.


Version published
Maintainers
1
Created

Readme

Source

md-links

Md-links es una interfaz de línea de comando (CLI) que facilita la lectura y análisis de archivos con formato Markdown, para generar reportes estadísticos de las URLs encontradas en éstos archivos.

Esta librería permite:

  • Obtener información básica del estado de los enlaces en los archivos .md
  • Adquirir información estadística sobre los enlaces totales, únicos y rotos en los archivos .md
  • Las validaciones se realizan a través de comandos descritos más adelante en la guía de uso

Índice

  • Instalación
  • Guía de uso
  • Diagrama de flujo
  • Dependencias adoptadas
  • Autor

1. Instalación

La instalación puede hacerse a través de la libreria con el comando

  npm i md-links-elimendeza

2. Guía de Uso

Para ejecutar la línea de comando en la terminal usar:

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

Opciones.

Al no ingresar ninguna opción

Se mostrará el texto, la URL y la ruta del archivo dónde el link fue encontrado

pathNoCommands

--help o -h

Se mostrará una tabla de ayuda con comandos válidos y ejemplos para aplicarlos.

--helpOptions

--stats o -s

Se mostrarán estadísticas básicas sobre los links | links totales y links únicos.

-sOption

--validate o -va

Se mostrarán el texto, la URL, la ruta del archivo (dónde el link fue encontrado) y una respuesta que valida el funcionamiento del link (con un codigo de status y un mensaje "Ok" o "Fail")

-vaOption

3. Diagrama de Flujo 1 y 2

API JavaScript 1

API

CLI (Command Line Interface) 2

CLI

4. Liberías empleadas 📚

5. Autor

Eliana Méndez 😋

Keywords

FAQs

Last updated on 11 Jun 2022

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc