Automatically discover and report broken links in GitHub repository README files
Many GitHub repositories contain README files with broken or outdated links. Repository owners and contributors are often unaware of these issues, as manually checking links across multiple repositories can be tedious and time-consuming.
This project provides both a web interface and a console application to automatically scan GitHub repositories and identify broken links in their README files.
📢 Found this tool through an issue we created? Please consider giving this repo a ⭐ or suggest improvements by opening an issue!
- 🔍 Automated Scanning - Searches GitHub for active repositories with README files
- 🌐 Web Interface - User-friendly web UI for on-demand repository checks
- 💻 Console Application - Batch processing tool for systematic scanning
- ⭐ Smart Filtering - Focuses on repositories with 100+ stars and recent commits
- 🔗 Link Validation - Comprehensive checking of all links in README files
- 📊 Detailed Reports - Saves findings with actionable information
- 🔐 GitHub API Integration - Optional Personal Access Token support for higher rate limits
Access the web interface at: https://GitHubReadMeChecker.com
The console application runs as a batch process and can find repositories with broken links in approximately 30 seconds.
-
Search Criteria: Scans GitHub repositories with:
- 100+ stars
- Commits within the last hour
-
Batch Processing: Checks 25 repositories per run (configurable)
-
Results: Broken link information is saved to a file for manual review and reporting
The GitHub API has rate limits to prevent abuse. Learn more: GitHub Rate Limiting
To increase your rate limit:
- Generate a Personal Access Token: GitHub Settings → Tokens
- Enter the token when prompted by the application
- Visit GitHubReadMeChecker.com
- Enter a repository URL or username
- View the results and broken links found
dotnet runFollow the on-screen prompts to:
- Enter your GitHub Personal Access Token (optional)
- Configure the number of repositories to check
- View real-time scanning results
Contributions are welcome! Here's how you can help:
- 🐛 Report Bugs - Open an issue describing the problem
- 💡 Suggest Features - Share your ideas for improvements
- 🔧 Submit Pull Requests - Help fix bugs or add features
- ⭐ Star the Repo - Show your support!
Other excellent tools for checking broken links via GitHub Actions:
This project is open source and available under the MIT License.
If you encounter any issues or have questions:
- Check existing Issues
- Open a new issue with detailed information
- Provide relevant error messages and screenshots
Made with ❤️ to help keep GitHub documentation clean and maintainable