md-links-elimendeza

1.0.1 • Public • Published

Md-Links

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


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 😋

Versions

Current Tags

  • Version
    Downloads (Last 7 Days)
    • Tag
  • 1.0.1
    2
    • latest

Version History

  • Version
    Downloads (Last 7 Days)
    • Published
  • 1.0.1
    2
  • 1.0.0
    1

Package Sidebar

Install

npm i md-links-elimendeza

Weekly Downloads

3

Version

1.0.1

License

MIT

Unpacked Size

967 kB

Total Files

22

Last publish

Collaborators

  • elianamendez