md-links-talitamsx v0.1.0
Markdown Links
Índice
1. Projeto MdLinks
Ferramenta de linha de comando (CLI) com a sua própria biblioteca (library) em JavaScript,
desenvolvida em Markdown, no qual é 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, o MdLinks é uma solução para automatizar a
verificação desses links .
2. Backlog
Para densenvolver o projeto, foi criado um fluxograma para planejar e compreender o processo de implementação de todas as partes do projeto.
3. Utlização
Comando : md-links ./"rota-do-arquivo"/"arquivo.md" (absoluta ou relativa)
Comando: md-links ./"rota-do-arquivo"/"arquivo.md" --validate
Comando: md-links ./"rota-do-arquivo"/"arquivo.md" --stats
Comando: md-links ./"rota-do-arquivo"/"arquivo.md" --stats --validate
1 year ago