md-links.francy
v1.0.3
Published
Libreria para encontrar archivos markdown, identificar si contiene links y el estado de ellos
Downloads
10
Maintainers
Readme
MDLinks Librería
Índice
1. Descripción de la librería
Esta librería busca principalmente apoyar los proyectos, en la lectura e identificación de archivos markdown, y dentro de ellos validar el código de estado de los links o urls existentes.
2. Instalación
Para la instalación de la librería se debe digitar el siguiente comando a través de la terminal de su editor de código, desde la terminal de Git Bash.
npm i md-links.francy
3. Guía de uso
- [ ]
' '
no ingresa ninguna opción, de esta manera la función no realiza validación, por lo cual imprime solo el texto del link encontrado, ubicación del archivo y url. Retorna un objeto como el siguiente:
- [ ]
'--validate' || '--v'
le solicita a la función realizar la validación de los links encontrados, por lo cual imprime el texto del link encontrado, ubicación del archivo, url, código de estado, y ok. Retorna un objeto como el siguiente:
- [ ]
'--stats' || '--s'
le solicita a la función realizar imprimir las estadísticas, por lo cual imprime Total de links encontrados, y cantidad de links no repetidos. Retorna un objeto como el siguiente:
- [ ]
'--stats' && '--validate'
le solicita a la función realizar las estadísticas y la validación, por lo cual imprime Total de links encontrados, cantidad de links no repetidos, y cuantos links rotos se encontrarón. Retorna un objeto como el siguiente:
El usuario debe ingresar la ruta ya sea relativa o absoluta entre comillas
- [ ] Desde la la terminal de Git Bash se debe ejecutar el comando
mdLinks <'ruta del archivo o diredtorio a examinar'> <options>
Desarrollo de la librería
Flujograma de trabajo - MDLinks