An open API service indexing awesome lists of open source software.

https://github.com/duducmt/nodejs-lib-links-markdown

Projeto simples desenvolvido com NodeJS para começar a conhecer os fundamentos de lib com a plataforma
https://github.com/duducmt/nodejs-lib-links-markdown

alura library node nodejs readme validation

Last synced: 3 months ago
JSON representation

Projeto simples desenvolvido com NodeJS para começar a conhecer os fundamentos de lib com a plataforma

Awesome Lists containing this project

README

          

# Markdown Links Validation - NodeJS Lib
[![](https://img.shields.io/badge/version-1.0.2-yellow)](#)

## 📝 Description
Extremely simple NodeJS library for listing and validating links within a [Markdown](https://www.markdownguide.org/getting-started/) file.

## 🚀 Objective
Get to know the fundamentals of NodeJS and creating libs with the framework.

## 📌 Important Note
This project was developed and tested only on version **14.19.1** of NodeJS. Make sure you are using the same version to avoid conflicts. In the future, greater compatibility with newer versions should be implemented. No module system of current ECMAScript was used.

## 🏁 Getting started
Install Markdown Links Validation
```
$ npm install -g md-links-validation
```

## 🔎 How to use
**List links on your markdown file**
```
md-links
```

**Validation of all links in your markdown file**
```
md-links
```

## 👷 Future Features
- Other visualization options for validated links
- Error handling for cases of invalid commands on the command line