apache / apache/cloudstack

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

Offen
#11,290 1 Kommentar 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen
type:enhancement
Vorherrschende Sprache
Java
Sterne
3.1k
Forks
1.4k
Ø Merge
6 T. 19 Std.
Gemergte PRs (30 T.)
32

Beschreibung

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

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginne mit den in der Issue verlinkten Abschnitten der README von markdown-link-check, insbesondere „Run as a pre-commit hook“ und „Config file format“. Ermittle den Speicherort der pre-commit-Konfiguration des Repositorys, füge den Hook und seine erforderlichen Regeln hinzu und führe anschließend die konfigurierten pre-commit-Prüfungen für Markdown-Dateien aus, um zu bestätigen, dass tote Links wie vorgesehen gemeldet werden.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
markdown
Bereich
documentation, tooling
Issue-Typ
Feature
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Ruhig
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
48/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.