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-geanemr

v0.1.4

Published

<div align="center">

Downloads

2

Vulnerabilities

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

Links

Git

Maintainers

geanemrgeanemr

Keywords

"node""markdown"

Readme

Markdown Links

Índice

1. Prefácio

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).

2. Resumo do projeto

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.

Pensando nisso, foi criado o projeto Md-links, com o objetivo de percorrer estes arquivos markdown, retornando as listas de links, textos e caminhos dos respectivos arquivos, além de informar quantos links de extensão .md esses arquivos possuem, se são únicos e se estão quebrados ou não.

3. Guia de instalação

Para instalar esta biblioteca você deve executar a seguinte linha de comando: npm install md-links-geanemr. Após a instalação, certifique de ter um arquivo .md com links dentro.

4. Guia de uso

a) Rode o comando mdlinks + o caminho relativo do seu arquivo , para obter os links dos arquivos (href), os textos (text) e os caminhos (file) dos mesmos:

md-links <caminho-do-arquivo>

b) Rode o comando abaixo para, além das informações acima, fazer uma requisição HTTP e receber o status e ok dos seus links:

md-links <caminho-do-arquivo> --validate

c) Você também pode receber informações estatísticas sobre os links. Rode o comando abaixo para saber qual o total de links do arquivo e quantos deles são únicos:

md-links <caminho-do-arquivo> --stats

d) E, para saber quantos destes arquivos únicos estão quebrados, rode o comando abaixo:

md-links <caminho-do-arquivo> --validate --stats

5. Fluxograma

Foi criado o seguinte fluxograma para auxiliar no desenvolvimento do projeto:

6. Organização do projeto

A ferramenta utilizada para organização do projeto foi o Github Projects:

7. Testes unitários

Cobertura de testes em jest:

8. Desenvolvedora

Geane Ramos

Github Badge Linkedin Badge