@govbr-ds/markdownlint-config
v4.2.2
Published
Configuração compartilhada do markdownlint para projetos do GovBR-DS
Downloads
554
Readme
GovBR-DS - Config Tools
Objetivo
Compartilhar os padrões de criação markdown entre os projetos do GovBR-DS.
Como instalar
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.
Crie um arquivo
.markdownlint.yml
na raiz do seu projeto e extenda a configuração:extends: '@govbr-ds/markdownlint-config'
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.
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:
Site do GovBR-DS http://gov.br/ds
Usando nosso canal no discord https://discord.gg/U5GwPfqhUP
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.