@govbr-ds/markdownlint-config NPM

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

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": "markdownlint -d --fix **/*.md",
  },
  "lint-staged": {
    "*.md": [
      "prettier --write",
      "markdownlint -d --fix"
    ]
  },

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