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

fernandacanicais-mdlinks

v1.0.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

2

Readme

Markdown Links

Índice

1. Introdução

Markdown é uma linguagem de marcação muito popular entre os programadores. É usada em muitas plataformas que manipulam texto (GitHub, fórum, blogs e etc) e é muito comum encontrar arquivos com este formato em qualquer repositório (começando pelo tradicional README.md).

Os arquivos Markdown normalmente contém links que podem estar quebrados, ou que já não são válidos, prejudicando muito o valor da informação que está ali.

Uma comunidade open source nos propôs criar uma ferramenta, usando Node.js, que leia e analise arquivos no formato Markdown, para verificar os arquivos que contenham links e mostrar algumas estatísticas.

2. Guia de Instalação 📈

Para instalar esta biblioteca você deve executar a seguinte linha de comando: npm install md-links XXXXXX. Observação: É necessário ter a instalação do Node. Após a instalação da biblioteca, certifique de ter um arquivo com a extensão (.md) com links dentro.

3. Guia de Uso 💬

No seu terminal rode o comando mdLinks + o caminho do arquivo e irá receber o caminho, texto e a url do arquivo selecionado.

mdLinks<caminho-do-arquivo>👇

preview

Além das informações acima, você poderá fazer uma requisição HTTP utilizando a propriedade --validate e receber o status e ok dos seus links.

mdLinks<caminho-do-arquivo> --validate👇

preview

Você poderá fazer a verificação das estatísticas dos links desse arquivo, utilizando a propriedade --stats, e receber o total de links encontrados no seu arquivo e quantos desses são únicos.

mdLinks<caminho-do-arquivo> --stats👇

preview

Você também pode combinar as propriedades e verificar a validação dos links e estatísticas do seu arquivo utilizando --validate --stats, e receber o total de links encontrados, quantos desses são únicos e quantos estão quebrados.

mdLinks<caminho-do-arquivo> --validate --stats👇

preview

4. Gerenciamento de projeto ✒️

Neste projeto, utilizei a ferramenta Git Projects para organização e mapear as tarefas, adotando a metodologia de sprints e priorização de backlog. E tambem utilizado o metodo de desenvolver um fluxograma para entender o objetivo do projeto backend.

Git Project:

preview

Fluxograma:

preview

5. Ferramentas utilizadas 🛠️

My Skills

6. Desenvolvedora👩‍💻

Fernanda Caniçais

linkedin github