Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/natichan/scl-2018-01-fe-markdown

Md-links-verification es una librería que lee y analiza archivos en formato Markdown, además extrae y verifica los links que contengan. Es muy común encontrar varios archivos en ese formato en cualquier tipo de repositorio empezando por el tradicional README.md.
https://github.com/natichan/scl-2018-01-fe-markdown

api-rest javascript jest node-js npm

Last synced: 3 months ago
JSON representation

Host: GitHub
URL: https://github.com/natichan/scl-2018-01-fe-markdown
Owner: natichan
Fork: true (Laboratoria/scl-2018-01-FE-markdown)
Created: 2018-08-20T11:47:36.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2018-10-24T11:43:27.000Z (about 6 years ago)
Last Synced: 2024-09-28T18:04:11.089Z (3 months ago)
Topics: api-rest, javascript, jest, node-js, npm
Language: JavaScript
Homepage: https://www.npmjs.com/package/md-links-verification
Size: 121 KB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# MD LINKS VERIFICATION

Markdown es un lenguaje de marcado ligero muy popular entre developers. Estos archivos Markdown normalmente contienen links que muchas veces estan rotos o ya no son validos y eso perjudica mucho el valor de la informacion que se quiere compartir. Md-links-verification es una libreria que lee y analiza archivos en formato Markdown, ademas extrae y verifica los links que contengan.

![screenshot from 2018-10-23 14-02-31](https://user-images.githubusercontent.com/39122711/47377699-60c51000-d6cc-11e8-81d6-096b5e4eafdd.png)

## Desarrollado para
[Laboratoria](https://www.laboratoria.la/)

### Instalación

Instalar como dependencia:
`npm i md-links-verification`

[NPM public library](https://www.npmjs.com/package/md-links-verification)

Instalar como interfaz
`npm install -g https://github.com/Laboratoria/scl-2018-01-FE-markdown`

### USO
#### CLI (Línea de comando)

El ejecutable de nuestra aplicación se ejecuta de la siguiente manera:

Linea que deberías ejecutar en tu terminal o consola:
`mdlinks [options]`

Debes ingresar el archivo directo

Por ejemplo:

```sh
$ mdlinks example.md
./some/example.md:10 http://algo.com/2/3/ Link a algo
./some/example.md:15 https://otra-cosa.net/algun-doc.html algún doc
./some/example.md:40 http://google.com/ Google
```
Identifica el archivo markdown (a partir de la ruta que recibe como
argumento), analiza el archivo Markdown e imprime los links que vaya
encontrando, junto con la ruta del archivo y la linea donde aparece, así como
también el texto que hay dentro del link.

`mdlinks --validate`

```sh
$ mdlinks example.md --validate
./some/example.md:10 http://algo.com/2/3/ ok 200 Link a algo
./some/example.md:15 https://otra-cosa.net/algun-doc.html fail 404 algún doc
./some/example.md:40 http://google.com/ ok 301 Google
```

Vemos que el _output_ en este caso incluye la palabra `ok` o `fail` después de
la URL, así como el status de la respuesta recibida a la petición HTTP a dicha
URL.
ccf3caa..4894bec master -> master ccf3caa..4894bec master -> master

### Ejemplo de uso
![Comando archivo con solo archivo](https://i.imgur.com/h4JUvkZ.png)
![Resultado](https://i.imgur.com/YMgSriK.png)
![Comando con archivo validate](https://i.imgur.com/Lxm5rNy.png)
![Resultado](https://i.imgur.com/Urj775C.png)

### Versiones
* 1.0.0
Versión de prueba (sin funcionamiento)
* 1.0.1
Versión de prueba exportando mdLinks (sin funcionamiento)
* 1.0.2
Versión que ofrece instalación como dependencia
* 1.0.3
Versión con README
* 1.0.4
Versión con dependencias instaladas para ser instaladas a nivel global, readme actualizado.
* 1.0.5
Versión con test para cada función.