README.md

Markdown Links

Instalación

npm install silvanarl/LIM012-fe-md-links

Diagrama de Flujo:

Board en GitHub Projects:

Boilerplate:

.
├── src
|  ├── cli.js
|  ├── main.js
|  ├── mdLinks.js
|  └── stats.js
├── test
|  ├── .eslintrc
|  ├── cli.spec.js
|  ├── main.spec.js
|  ├── stats.spec.js
|  └── mdLinks.spec.js
├── .eslintrc
├── .gitignore
├── babel.config.js
├── CODE_OF_CONDUCT.md
├── LISENCE
├── package-lock.json
├── package.json
└── README.Md

directory: 5 file: 24

Ejemplo

const mdLinks = require("md-links");

mdLinks("./some/example.md")
  .then(links => {
    // => [{ href, text, file }]
  })
  .catch(console.error);

mdLinks("./some/example.md", { validate: true })
  .then(links => {
    // => [{ href, text, file, status, ok }]
  })
  .catch(console.error);

mdLinks("./some/dir")
  .then(links => {
    // => [{ href, text, file }]
  })
  .catch(console.error);

CLI (Command Line Interface - Interfaz de Línea de Comando)

md-links <path-to-file> [options]

Por ejemplo:

Options

--validate

Si pasamos la opción --validate, el módulo debe hacer una petición HTTP para averiguar si el link funciona o no.

Por ejemplo:

--stats

Si pasamos la opción --stats el output (salida) será un texto con estadísticas básicas sobre los links.

También podemos combinar --stats y --validate para obtener estadísticas que necesiten de los resultados de la validación.