1.0.0 • Published 2 years ago

md-links-made v1.0.0

Weekly downloads
-
License
ISC
Repository
github
Last release
2 years ago

1. Markdown Links

Markdown Links es una librería que usa Node.js, que lee y analiza archivos en formato Markdown, para verificar los links que contenga y reporta estadísticas.

2. Instalación:tw-1f518:

Instale la librería ejecutando el siguiente código:

npm install md-Links-made

3. Instrucciones de uso :tw-1f4bb:

Puedes ingresar dos opciones: --validate y/o --stats

  • path: Ruta absoluta o relativa al archivo o directorio.
  • options: Un objeto con únicamente la siguiente propiedad:

    validate: Booleano que determina si se desea validar los links encontrados..

Ingreso sin opciones:

md-Links path

Se obtienen los siguientes datos:

* `href`: URL encontrada.
* `text`: Texto que aparecía dentro del link (`<a>`).
* `file`: Ruta del archivo donde se encontró el link.

!--validate!--stats

Opción --validate

Se obtienen los siguientes datos:

* `href`: URL encontrada.
* `text`: Texto que aparecía dentro del link (`<a>`).
* `file`: Ruta del archivo donde se encontró el link.
* `status`: Código de respuesta HTTP.
* `ok`: Mensaje `fail` en caso de fallo u `ok` en caso de éxito.

--validate

Opción --stats

Se obtienen los siguientes datos:

Total: 3
Unique: 3

--stats

Opción --validate --stats

Se obtienen los siguientes datos:

$ md-links ./some/example.md --stats --validate
Total: 3
Unique: 3
Broken: 1

--validate--stats

4. Autor :tw-1f33b:

Madelen Illanes