mdlinks-fico v0.1.1
Markdown Links
Índice
- 1. Preámbulo
- 2. Resumen del proyecto
- 3. Objetivos de aprendizaje
- 4. Consideraciones generales
- 5. Criterios de aceptación mínimos del proyecto
- 6. Entregables
- 7. Hacker edition
- 8. Pistas, tips y lecturas complementarias
- 9. Checklist
- 10. Achicando el problema
1. Preámbulo
Markdown es un lenguaje de marcado
ligero muy popular entre developers. Es usado en muchísimas plataformas que
manejan texto plano (GitHub, foros, blogs, ...) y es muy común
encontrar varios archivos en ese formato en cualquier tipo de repositorio
(empezando por el tradicional README.md
).
2. Guía de uso e instalación
Para la instalación se debe colocar el siguiente comando:
npm i mdlinks-fico
Esta aplicación se ejecuta de la siguiente manera a través de la terminal:
md-links options
Para extraer los links de una ruta de un archivo Markdown, se coloca lo siguiente:
$ mdLinks ./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
Option
--validate
Si pasamos la opción --validate, el módulo hace una petición HTTP para averiguar si el link funciona o no. Si el link resulta en una redirección a una URL que responde ok, entonces consideraremos el link como ok.
$ mdLinks ./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
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.
--stats
Si pasamos la opción --stats el output (salida) es un texto con estadísticas básicas sobre los links.
$ mdLinks ./some/example.md --stats Total: 3 Unique: 3
También se puede combinar --stats y --validate para obtener estadísticas que necesiten de los resultados de la validación.
$ mdLinks ./some/example.md --stats --validate Total: 3 Unique: 3 Broken: 1