Como Automatizar Verificações Simples

Se você deseja automatizar algumas verificações em seus documentos Markdown, existem várias ferramentas que você pode utilizar. Por exemplo:

• Análise de Código / Linting
  • markdownlint para verificar a sintaxe do Markdown e aplicar regras que tornem o texto mais legível.
  • markdown-link-check para extrair links de textos em Markdown e verificar se cada link está funcionando (200 OK) ou morto.
  • proselint para verificar jargão, erros de ortografia, redundância, linguagem corporativa e outras questões relacionadas à linguagem.
  • write-good para verificar a prosa em inglês.
  • Imagem Docker para node-markdown-spellcheck, uma imagem Docker leve para verificar a ortografia de arquivos Markdown.
  • Análise de código estático
• Extensões do VS Code
  • Write Good Linter para obter conselhos gramaticais e de linguagem enquanto edita um documento.
  • markdownlint para examinar documentos Markdown e obter avisos sobre violações de regras durante a edição.
• Automação
  • pre-commit para usar scripts de hook do Git para identificar problemas simples antes de enviar nosso código ou documentação para revisão.
  • Verifique Validação de Build para automatizar a verificação de PRs.
  • Verifique Pipeline de CI para melhor documentação para um exemplo de pipeline com markdownlint, markdown-link-check e write-good.

Exemplo de saída:

Sobre as regras de linting

A equipe precisa estar clara sobre quais regras de linting são necessárias e não devem ser substituídas por ferramentas ou comentários. A equipe deve chegar a um consenso sobre quando substituir as regras das ferramentas.