markdown-checklinks-multiarquive
Version:
Verifica os links de vários arquivos markdown em uma pasta
102 lines (71 loc) • 2.41 kB
Markdown
<a id="MarkDown"></a>
Node MarkDown Check Links Multi-Arquive
=========
Este projeto em Node.js que acessa vários arquivos markdown (.md) dentro de uma pasta e verifica os links, após isso é gerado um relatório de links quebrados, caso exista algum.
<img src="https://brunorivolta.x10.mx/imagens/markdownProject.png" alt="Projeto MarkDown"/>
<a id="tabela-de-conteudo"></a>
Tabela de conteúdos
=================
<!--ts-->
* [Sobre](#MarkDown)
* [Tabela de Conteudo](#tabela-de-conteudo)
* [Instalação](#instalacao)
* [Como usar](#como-usar)
* [Pré Requisitos](#pre-requisitos)
* [Dependências](#dependencias)
* [Tests](#teste)
* [Tecnologias](#tecnologias).
* [Contato](#contato)
<!--te-->
<a id="instalacao"></a>
Instalação
=================
Baixe o projeto no GitHub
https://github.com/BrunoRivolta/Node_MarkDown_Check_Links_MultiArquive
*Instalação das dependências via NPM*
```bash
$ npm install -g markdown-checklinks-multiarquive
```
<a id="como-usar"></a>
Como usar
=================
Após a instalação, coloque os seus arquivos markdown dentro da pasta 'arquivos' na raiz do projeto. Esta pasta pode ser modificada no arquivo package.json.
*Comando para exibir a lista de links*
```bash
$ npm run cli
```
*Comando para verificar os links e gerar um relatório*
```bash
$ npm run cli validar
```
<a id="pre-requisitos"></a>
Pré Requisitos
=================
* Node.js
<a id="dependencias"></a>
Dependências
=================
* chalk
* node-fetch
* @babel/preset-env
* babel-jest
* jest
<a id="teste"></a>
Testes
=================
Testes realizados com o jest.
*Comando para executar o jest*
```bash
$ npm run test
```
<a id="tecnologias"></a>
Tecnologias
=================
Desenvolvido para node.js.
<a id="contato"></a>
Contato
=================
<img src="https://img.icons8.com/fluency/344/apple-mail.png" alt="Email" width="50"/>bruno.toniati@hotmail.com
<img src="https://img.icons8.com/fluency/344/window.png" alt="WebSite" width="50"/>https://brunorivolta.x10.mx/
<img src="https://img.icons8.com/color/344/github.png" alt="GitHub" width="50"/>https://github.com/BrunoRivolta
<img src="https://img.icons8.com/color/344/linkedin-circled--v1.png" alt="Linkedin" width="50"/>https://www.linkedin.com/in/brunorivolta/