README.md

Markdown Links

Índice

• 1. Sobre
• 2. Como instalar
• 3. Como utilizar
• 4. Ferramentas utilizadas

---

1. Sobre

Esta biblioteca extrai links de url em um arquivo markdown, podendo ser executada diretamente pelo terminal ou importado com require para ser utilizada em seu código. O retorno da função é uma promessa (Promise) que resolve uma array (Array) e objetos (Objects), onde cada objeto representa um link, contendo as seguintes propriedades:

href: URL encontrada.

text: Texto dentro do markdown.

2. Instalação

Para utilizar a biblioteca é necessário ter instalado o Node.js

Para instalar a biblioteca utilize o seguinte comando no terminal:

npm install -g tayaracaires/SAP003-md-links

4. Como utilizar

A partir do terminal:

md-links <endereço-do-arquivo>

Por exemplo:

$ md-links ./documents/example.md
http://exemplo.com - Link de exemplo
http://google.com/ - Google

Caso nenhum link seja encontrado:

$ md-links ./documents/example.md
No matches found

Outro forma de utilizar é importando o modulo utilizando require, por exemplo:

> const mdlinks = require('md-links');
> mdlinks('path/exemple.md')
  .then((link) => {
  console.log(`${href} - ${text}`)
})
  //returns 'link - title'

5. Ferramentas utilizadas

Para desenvolver esta biblioteca, foram utilizadas as seguintes ferramentas:

• JavaScript
• GIT
• GitHub
• Node js
• Jest
• Visual Studio Code
• Trello

---