apache / apache/cloudstack

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

Abierto
#11,290 1 comentario 1 reacción 0 asignados Ver en GitHub
type:enhancement
Lenguaje dominante
Java
Estrellas
3.1k
Forks
1.4k
Merge medio
6 d 19 h
PR fusionados (30 d)
32

Descripción

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

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

Comienza con las secciones del README de markdown-link-check enlazadas en la issue, especialmente “Run as a pre-commit hook” y “Config file format”. Determina la ubicación de la configuración de pre-commit del repositorio, añade el hook y sus reglas requeridas, y después ejecuta las comprobaciones de pre-commit configuradas contra los archivos Markdown para confirmar que los enlaces rotos se notifican como se espera.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
markdown
Área
documentation, tooling
Tipo de issue
Nueva funcionalidad
Dificultad
3/5
Tiempo estimado
1-2 días
Estado de actividad
Tranquilo
Claridad
Bastante claro
Aptitud para principiantes
48/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.