ysisc-md-links

1.0.3 • Public • Published

Markdown Links

Índice


1. ACERCA DE MDLINKS

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.

md-links

2.COMO INSTALAR MD LINKS

npm i ysisc-md-links

3. Implementacion de uso

Si necesitas ayuda:

md-links <path> --help

mdlinks-help.png

En caso de necesitar los links

md-links <path> --validate

Getting Started

En caso de necesitar los links totales exitoso y rotos

md-links <path> --validate --stats

Getting Started

En caso de necesitar los links totales exitoso

md-links <path> --stats

Getting Started

4. Diagrama de flujo

Diagrama de MD-LINKS

md-links diagrama

Diagrama de CLI

cli diagrama

5. Checklist

General

  • [x] Puede instalarse via npm install --global <github-user>/md-links

README.md

  • [x] Un board con el backlog para la implementación de la librería.
  • [x] Documentación técnica de la librería.
  • [x] Guía de uso e instalación de la librería

API mdLinks(path, opts)

  • [x] El módulo exporta una función con la interfaz (API) esperada.
  • [x] Implementa soporte para archivo individual
  • [x] Implementa soporte para directorios
  • [x] Implementa options.validate

CLI

  • [x] Expone ejecutable md-links en el path (configurado en package.json)
  • [x] Se ejecuta sin errores / output esperado
  • [x] Implementa --validate
  • [x] Implementa --stats

Pruebas / tests

  • [x] Pruebas unitarias cubren un mínimo del 70% de statements, functions, lines, y branches.
  • [x] Pasa tests (y linters) (npm test).

Package Sidebar

Install

npm i ysisc-md-links

Weekly Downloads

0

Version

1.0.3

License

ISC

Unpacked Size

242 kB

Total Files

23

Last publish

Collaborators

  • ysiscl