apache / apache/cloudstack

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

Ouverte
#11,290 1 commentaire 1 réaction 0 personnes assignées Voir sur GitHub
type:enhancement
Langage dominant
Java
Étoiles
3.1k
Forks
1.4k
Merge moyen
6 j 19 h
PR mergées (30 j)
32

Description

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

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Commencez par les sections du README de markdown-link-check liées dans l’issue, en particulier « Run as a pre-commit hook » et « Config file format ». Déterminez l’emplacement de la configuration pre-commit du dépôt, ajoutez le hook et les règles requises, puis exécutez les vérifications pre-commit configurées sur les fichiers Markdown afin de confirmer que les liens morts sont signalés comme prévu.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
markdown
Domaine
documentation, tooling
Type d'issue
Fonctionnalité
Difficulté
3/5
Temps estimé
1-2 jours
Activité
Calme
Clarté
Plutôt claire
Accessibilité débutants
48/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.