README GitHub & Liens : Le Guide Ultime
Votre README est la première page produit de votre dépôt. Si les liens d’installation, de contribution ou de documentation cassent, les utilisateurs perdent confiance avant même d’essayer le projet.
Chemins relatifs vs liens absolus
Privilégiez les chemins relatifs comme docs/install.md ou ../guides/setup.md. Ils résistent mieux aux forks, aux miroirs et aux changements de branche par défaut que les URLs complètes.
Liens à vérifier en priorité
- Installation, quick start, exemples, configuration locale.
- Contribution, code of conduct, changelog, sécurité.
- Ancres internes dans les longs README.
- Liens externes vers docs API, démos, communauté et support.
Automatisation via GitHub Actions
N’attendez pas les retours utilisateurs. Ajoutez un workflow de contrôle dans les pull requests pour bloquer les régressions de documentation dès le review.
Pour une vérification immédiate, lancez un scan avec DeadLinkTool sur l’URL GitHub du README ou en collant directement le Markdown.
Related workflows
Use the workflow page that matches your source format so the checker and fixing options stay accurate.
Prêt à nettoyer vos liens ?
Ouvrez le workflow le plus adapté à ce guide et vérifiez vos liens en quelques secondes.
Ouvrir le workflow recommandéArticles similaires
Top 5 des erreurs de liens sur GitHub
Guide pratique pour identifier et corriger les erreurs de liens les plus fréquentes dans les README GitHub, la documentation Markdown et les fichiers de projet.
Corriger des liens Markdown et exporter une documentation propre
Workflow pratique pour corriger des liens Markdown cassés, vérifier les remplacements et exporter une documentation propre pour GitHub ou GitLab.