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

@govbr-ds/markdownlint-config

v4.2.2

Published

Configuração compartilhada do markdownlint para projetos do GovBR-DS

Downloads

647

Readme

GovBR-DS - Config Tools

Objetivo

Compartilhar os padrões de criação markdown entre os projetos do GovBR-DS.

Como instalar

  1. Instale os seguintes pacotes:

    npm install -D @govbr-ds/markdownlint-config husky cross-env

Como configurar

Configurações para o Markdownlint e também usamos o Markdownlint-cli.

  1. Crie um arquivo .markdownlint.yml na raiz do seu projeto e extenda a configuração:

    extends: '@govbr-ds/markdownlint-config'
  2. Crie um arquivo .markdownlintignore na raiz do seu projeto e inclua os arquivos e pastas que deseja ignorar da validação de markdown:

    CHANGELOG.MD
    node_modules

    Quando o CHANGELOG.md é gerado automaticamente é recomendável o excluir da verificação.

  3. Conforme a documentação do Husky inclua o hook pre-commit com o código abaixo:

    npx --no -- lint-staged

    E configure o package.json com o seguinte script:

      "scripts": {
         "lint:md": "cross-env markdownlint -d -f '**/*.md'",
      },
      "lint-staged": {
         "*.md": [
           "markdownlint -d -f"
         ]
      },

Como contribuir?

Antes de abrir um Merge Request tenha em mente algumas informações:

  • Esse é um projeto opensource e contribuições são bem-vindas.
  • Para facilitar a aprovação da sua contribuição, escolha um título curto, simples e explicativo para o MR, e siga os padrões da nossa wiki.
  • Quer contribuir com o projeto? Confira o nosso guia como contribuir.

Reportar bugs/necessidades

Você pode usar as issues para nos informar os problemas que tem enfrentado ao usar nossa biblioteca ou mesmo o que gostaria que fizesse parte do projeto. Por favor use o modelo que mais se encaixa na sua necessidade e preencha com o máximo de detalhes possível.

Nos comprometemos a responder a todas as issues

Precisa de ajuda?

Por favor não crie issues para fazer perguntas...

Use nossos canais abaixo para obter tirar suas dúvidas:

Padrão de commits

Para mais informações sobre o padrão de commits consulte a nossa Wiki.

Licença

Nesse projeto usamos a licença MIT.