https://github.com/nottherealwallyx/linksentinel
Scan Markdown and reStructuredText docs for broken links. CLI tool and GitHub Action for automated link checking.
https://github.com/nottherealwallyx/linksentinel
ci-cd cli documentation github-actions link-checker linting markdown open-source python restructuredtext
Last synced: about 2 months ago
JSON representation
Scan Markdown and reStructuredText docs for broken links. CLI tool and GitHub Action for automated link checking.
- Host: GitHub
- URL: https://github.com/nottherealwallyx/linksentinel
- Owner: NotTheRealWallyx
- License: mit
- Created: 2025-06-17T18:29:13.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-06-17T20:36:23.000Z (about 1 year ago)
- Last Synced: 2025-06-17T21:32:51.466Z (about 1 year ago)
- Topics: ci-cd, cli, documentation, github-actions, link-checker, linting, markdown, open-source, python, restructuredtext
- Language: Python
- Homepage:
- Size: 45.9 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# LinkSentinel
LinkSentinel is a GitHub Action and CLI tool that scans your Markdown (.md) and reStructuredText (.rst) documentation files for dead links and reports them in your CI workflow.
## Features
- Detect broken external links (HTTP errors, timeouts, etc.)
- Supports `.md` and `.rst` formats
- Easy GitHub Action integration for CI/CD pipelines
- Clear reporting of broken links with file paths
## Usage
### As CLI
```bash
pip install requests
python link_validator.py ./docs
```
Or, if installed as a package or running from the project root:
```bash
python -m linksentinel ./docs
```
### As GitHub Action
```yaml
uses: NotTheRealWallyx/LinkSentinel@v1.0.0
with:
path: './docs'
```
## Why LinkSentinel?
Documentation quality is critical, especially for large open-source projects.
LinkSentinel helps ensure your docs don’t have dead links, improving user experience and reducing frustration.
---
## License
This project is licensed under the GNU GPL v3.