md-links

md-links is a library that allows you to analyze .md files in search for links.

You can list them, validate them and/or provide some stats with the given directory or specific .md file.

Building Process

Everything started with a chart that represents the ideal workflow, including as many cases as possible considering the user (mostly developers):

Installation

You can install this module to your project by running: $ npm install pamelazoe-md-links

To install globally: $ npm install -g pamelazoe-md-links

In case this fails, you can use the prefix sudo which is not recommended for npm installations: $ sudo npm install pamelazoe-md-links

Instead fix your npm permissions.

Pre-requisites

Node.js

Usage

md-links <path> <options>

• path: It could be absolute or relative to the file or directory, and this argument by itself will only return the path file, url and the text associated:
  • file: route of the file where the link was found.
  • href: found URL.
  • text: text associated with the link.

Warning: The options feature is under construction.

• options: Object with the following properties:

· --validate: Boolean that determines if you want to validate the links found in the given path. The module will make an HTTP request to find out if the link still works or is broken. The output will be ok for working links and fail for broken links.

· --stats: It outputs basic stats as Found and Unique links.

· --validate --stats: This properties can be combined for stats according to validation status.

No path case (under construction).

• If no path is given, the library will run according to the directory located at the moment.

Challenges

This project has been very exciting for me, even if I do not understand it in all its extension. The biggest challenge for me was to understand how Node.js works and how it communicates with JavaScript and the console, and the process to turn it to an npm package.