0.1.0 • Published 8 months ago

cecy-md-links v0.1.0

Weekly downloads
-
License
MIT
Repository
github
Last release
8 months ago

cecy-md-links

Índice

  • Preámbulo

  • Acerca de cecy-md-links

  • Como instalar md-links

  • Como usar md-links

  • Opciones de comandos

  • Ejemplos de usabilidad

  • Como desinstalar md-links

  • Diagramas de flujo.

  • Pistas, tips y lecturas complementarias

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).

Estos archivos Markdown normalmente contienen links (vínculos/ligas) que muchas veces están rotos o ya no son válidos y eso perjudica mucho el valor de la información que se quiere compartir.

Dentro de una comunidad de código abierto, nos han propuesto crear una herramienta usando Node.js, que lea y analice archivos en formato Markdown, para verificar los links que contengan y reportar algunas estadísticas.

Acerca de cecy-md-links

Con cecy-md-links como librería puedes validar fácilmente en tus archivos y/o directorios la presencia de links, estatus de una manera fácil y colorida

Como instalar md-links

Para instalar Md-links solo debes escribir en la terminal el siguiente comando:

npm i md-links

Cómo usar cecy-md-links

  • En la consola agrega lo siguiente:

    md-links + La ruta relativa del archivo, ejemplo: ./nombredeCarperta + Opciones de comandos

Opciones de comandos:

(--validate o --v ) Para ver enlaces de validación, realiza una solicitud HTTP para saber si el enlace funciona o no.

( --validate o --stats/ --v o --s ) Para ver estadísticas sobre enlaces : total, unicos, y rotos.

(--stats o --s ) Para ver estadísticas sobre enlaces.

(--help o --h) Para ver el menú que muestra todos los comandos.

Ejemplos de usabilidad

  • Agragando ruta y opción md-links-archivo-opción
  • Sin archivo ni opciones Si no ingresas nada
  • Si se ingresa una ruta inválida Si ingresas una ruta inválida

Como desinstalar md-links

Para desinstalar cecy-md-links sólo debes ingresar en la terminal en la ubicación del archivo donde la has instalado el siguiente comando:

npm uninstall -D md-links

Diagramas de flujo.

Diagrame de flujo

Pistas, tips y lecturas complementarias

Otros recursos

axioschalkyargs
@everything-registry/sub-chunk-1304
0.1.0

8 months ago