Markdown Links Project

Demo

Introduction

This is a library created in JavaScript using Node.js® which is a JavaScript runtime built on Chrome's V8 JavaScript engine.

This library can be used to check the links' file with .md (Markdown) extension and then report some statistics.

The Flowchart's project goes like this:

Markdown can be defined as a plain text formatting syntax used to write content on the web. It’s commonly used by writers and programmers to write quickly without having to take time using the formatting toolbar of text editors.

How to use:

Installation

At your console stay in the folder where you want to install the module and all you have to do is write this in the Command Line Interface (CLI): npm i md-links-marinaestefania --save

Another thing you can do is clone or download this repository at your computer and then follow user guide.

User Guide

A new folder should be created. Inside it you can find an exampleFile.md to practice but if you want to try with a diferent file you just have to make sure that enter the correct path in the CLI. At present, it only supports files.md wich means that you can't put a folder path but in the future I will be working on it.

Write in the CLI the standar sentense followed by one of the next key words to get into an option:

standar sentence: node pathOfTheFilemd-links.js fileToCheckLinks

Option 1: don't write any option. Use this option if you want to print on screen all the links and their respective titles gotten from the file that you choose to check.

Example:
node src/md-links.js src/exampleFile.md

Option 2: validate Use this option if you want to see the list of links and its HTTP status codes. That way you could know if the url's are active or not.

Example:
node src/md-links.js src/exampleFile.md validate

Option 3: stats Use this option if you want to know the total amount of the links contained in the file given. Example:
node src/md-links.js src/exampleFile.md stats

Option 4: validate-stats Use this option to see the total of links, How many links are working and how many links presents bad request. Example:
node src/md-links.js src/exampleFile.md validate-stats

Documentation

• Node.js curso desde cero en Youtube

• Node Fetch package oficial documentation

• NPM Install oficial documentation

• Chalk package oficial documentation

• Jest package oficial documentation

• Process (argv) oficial documentation

• Match method MDN

• Exec method MDN

• Regular Expressions Maker

• Node.js.

• Node.js File System documentation.

• Node.js Path documentation.

• HTTP 400 and 500 Status Codes

• Promises MDN

• forEach Method MDN

• CLI

• Guia test de codigo asincronico