0.1.1 • Published 2 years ago

md-links-gis v0.1.1

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

Markdown Links

Índice 📋


1. Características de la libreria 📃

Md-links es una libreria que te ayuda a encontrar links válidos y rotos además de las estadísticas de estos en archivos de extensión md.

2. Diagrama de Flujo

!(https://github.com/Gisbelc/BOG004-md-links/blob/work/Diagrama%20de%20Flujo.png)

Diseño del diagrama de flujo, para llevar un orden en la ejecución del proyecto.

3. Instalación🔧

Tu puedes instalar esta libreria ingresando este comando en tu terminal

$ npm install md-links-gis

4. Modo de uso💻

Una vez instalada la libreria, debes ejecutarlo en la terminal

mdlinks (path-to-file) options

NOTA: TU RUTA PUEDE SER RELATIVA O ABSOLUTA

SI ES ABSOLUTA DEBE ESTAR ENTRE COMILLAS

5. Opciones disponibles 📓

Si ingresas la ruta sin opciones obtendras como resultado lo siguiente:

  • href: URL encontrada.
  • text: Texto que aparecía dentro del link.
  • file: Ruta del archivo donde se encontró el link.

Ejemplo:

$ md-links ./some/example.md
./some/example.md http://algo.com/2/3/ Link a algo
./some/example.md https://otra-cosa.net/algun-doc.html algún doc
./some/example.md http://google.com/ Google

Con --validate o --v : Nos muestra las validaciones de los links

  • href: URL encontrada.
  • text: Texto que aparecía dentro del link.
  • 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.

Ejemplo:

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

Con --stats o --s : Nos muestra una estadística básica de links.

  • Total: Links totales.
  • Unique: Links unicos.

Ejemplo:

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

Si combinamos ambos --validate --stats o --v --s : Nos muestra las estadisticas y le agrega los links rotos.

  • Total: Links totales.
  • Unique: Links unicos.
  • Broken: Links rotos.

Ejemplo:

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

6. Autor ♥

Gisbel Contreras