npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

md-links-raquel-maia

v0.1.0

Published

* [1. Prefácio](#1-prefácio) * [2. Resumo do projeto](#2-resumo-do-projeto) * [3. Objetivos de aprendizagem](#3-objetivos-de-aprendizagem) * [4. Considerações gerais](#4-considerações-gerais) * [5. Critérios de aceitação mínimos do projeto](#5-criteri

Downloads

3

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

raquelmaiaraquelmaia

Keywords

markdownnodejsarquivos md

Readme

Markdown Links

Índice

1. Resumo

Markdown é uma linguagem de marcação muito popular e amplamente utilizada entre programadores e escritores online. Ela foi projetada para ser de fácil leitura e escrita, permitindo a conversão para HTML e outros formatos de apresentação.

No projeto 'Markdown Links', desenvolvido durante o bootcamp da Laboratoria, foi criada uma biblioteca em Node.js com o objetivo de ler arquivos Markdown (.md) e verificar os links contidos neles. O foco principal desse projeto foi aprimorar o conhecimento em manipulação de arquivos, trabalhar com a CLI (command-line interface) e obter estatísticas sobre os links encontrados. Com essa biblioteca, tornou-se mais simples e eficiente realizar a validação de links em arquivos Markdown."

2. Instalação da biblioteca

Para instalar a biblioteca, execute o seguinte comando no terminal:

🔹npm install md-links-raquel-maia

3. Fluxograma

4. Instrução de uso

🟣 Listagem de Links

Comando 1 > md-links ./caminhoDaPasta/nomeDoArquivo.md

Esse comando procura arquivos na rota especificada, e imprime através de uma tabela os links extraídos, juntamente com o texto descritivo do link e a rota do arquivo em que cada link foi encontrado, como o exemplo abaixo:

🟣 Validação de Links

Comando 2 > md-links ./caminhoDaPasta/nomeDoArquivo.md --validate

Esse comando fará uma requisição HTTP para verificar se cada link funciona ou não, apresentando uma tabela com o código de resposta (status HTTP) e uma mensagem correspondente em caso de sucesso (ok) ou falha (fail). Veja exemplo abaixo:

🟣 Estatísticas de links

Comando 3 > md-links ./caminhoDaPasta/nomeDoArquivo.md --stats

Esse comando --stats, exibirá em uma tabela o número total de links encontrados no arquivo e o total de links únicos.

🟣 Validação + Estatísticas de links

Comando 4 > md-links ./caminhoDaPasta/nomeDoArquivo.md --stats --validate

Esses dois comandos juntos --validate --stats exibirá em uma tabela o número total de links encontrados no arquivo, o total de links únicos, e o número total de links quebrados.

5. Tecnologias utilizadas