Skip to content

Naandalist/md-links-sentinel

Repository files navigation

md-links-sentinel

md-links-sentinel is a TypeScript-based utility for validating hyperlinks in Markdown files. It extracts URLs, performs HTTP/HTTPS requests, and reports link statuses. The tool provides a console interface with progress tracking, detailed logging, and result summaries, categorizing links by HTTP status codes with emphasis on 404 errors.

Screenshoot of usage in vscode

It's designed for efficient documentation maintenance, finding dead-link, and link integrity verification.

Name Etymology

  • "md" : Abbreviation for Markdown, indicating the file type this tool processes.
  • "link": Specifies the tool's primary function - link checking.
  • "sentinel": Implies vigilance and monitoring, which is exactly what this tool is doing. It watches over links and reports their status.

To install dependencies:

bun install

To run:

bun run index.ts

This project was created using bun init in bun v1.1.8. Bun is a fast all-in-one JavaScript runtime.

About

Dead-link finder of MD files.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published