Welcome 👩‍💻

contents

• 1 . Project objectives
• 2 . Project flow chart
  • API
  • CLI
• 3 . Documentation
  • Installation
  • usage
  • Commands
  • Example

1. Project objectives

The maskay-links-md library parses files with the extension Markdown, allows you to obtain all the existing links within a file and with the commands you will be able to know more details about each and total statistics.

2 . Project flow chart

• API development

• CLI(Command Line Interface) Development

3. Documentation

• Installation

npm i maskay-links-md

• Usage

The default behavior does not validate if the URLs respond ok or not, it only has to identify the markdown file (from the path it receives as an argument), analyze the Markdown file and print the links it finds, along with the file path where it appears and the text inside the link.

Use the library in the terminal, with the following command:

maskay-links-md

After that it will ask you to place a path, this can be relative or absolute.

Choose an option:

--default
--validate
--stats
--stats --validate
--hepl
--exit

• Commands

Arguments

path

Absolute or relative path to the file or directory.

Options

--default

Shows basic information about the content of the inspected file

--validate

If we choose the --validate option, the module must make an HTTP request to find out if the link works or not. If the link results in a redirect to a URL that answers ok, then we will consider the link as ok, otherwise it will be false

• href: URL found.
• text: Text that appeared inside the link (<a>).
• file: Path of the file where the link was found.
• status: HTTP response code.
• ok: Message fail in case of failure or ok in case of success.

 --stats

If we pass the --stats option the output will be a text with statistics Basics about links.

• Total: Total links within the file you are inspecting
• Unique: Total number of links within the file you are inspecting that do not repeat

--stats --validate

We can also combine --stats and --validate to get statistics that need the validation results.

--help

Information about stock options.

--exit

Close or exit the program

• Example

For example:

### this is a content of a .md file
  ![This is an example image](https://ejemplo.com/imagen.jpg)
  [google]( http://google.com/)
  [yahoo]( http://search.yahoo.com/)
  [msn](http://search.msn.com/)
  [hotmail](http://hotmail.com/)
  [trend google](https://trends.google.com.mx/trends/explore?q=react,angular,vue)

Results :

Open the terminate and run maskay-links-md

Result when executing the option --default

Result when executing the option --validate

Result when executing the option --stats

Result when executing the option --stats --validate

<img src="img/6preview.png"width=50 height=45 >Result when executing the option --help

• Source :

Repository of Laboratoria

• Author :

👩 Melania Palomino