apache / apache/cloudstack

Add `markdown-link-check` with `pre-commit` to check for dead links in Markdown files

Aberta
#11,290 1 comentário 1 reação 0 responsáveis Ver no GitHub
type:enhancement
Linguagem predominante
Java
Estrelas
3.1k
Forks
1.4k
Merge médio
6d 19h
PRs com merge (30d)
32

Descrição

https://github.com/tcort/markdown-link-check

https://github.com/tcort/markdown-link-check?tab=readme-ov-file#run-as-a-pre-commit-hook

```
- repo: https://github.com/tcort/markdown-link-check
rev: ...
hooks:
- id: markdown-link-check
args: [-q]
```

We will need a config file with various rules:

https://github.com/tcort/markdown-link-check?tab=readme-ov-file#config-file-format

Guia de contribuição

Abrir o guia de contribuição

Direção de pesquisa

Comece pelas seções do README do markdown-link-check vinculadas na issue, especialmente “Run as a pre-commit hook” e “Config file format”. Determine a localização da configuração do pre-commit do repositório, adicione o hook e suas regras necessárias e, em seguida, execute as verificações de pre-commit configuradas nos arquivos Markdown para confirmar que links quebrados são reportados conforme esperado.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
markdown
Domínio
documentation, tooling
Tipo de issue
Funcionalidade
Dificuldade
3/5
Tempo estimado
1-2 dias
Status de atividade
Pouca atividade
Clareza
Razoavelmente clara
Facilidade para iniciantes
48/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.