#broken-links #markdown #link #checker #local #find #web

bin+lib mdlc

Markdown Link Checker. Find broken web and local links.

5 releases (breaking)

0.8.1 Jan 17, 2024
0.7.0 Oct 17, 2022
0.6.0 Mar 10, 2021
0.5.0 Mar 10, 2021
0.4.0 Mar 10, 2021

#11 in #broken-links

36 downloads per month

GPL-3.0-only

14KB
150 lines

mdlc - Markdown Link Checker

Rust

The aim of this tool is to read in all parsed markdown files, extract all links (both local, for files, and remote), and then report which of these links are broken.

TODO

  • Get HashMap<String, Vec<String>>, representing Filename: links pairs
  • Split links into local and web
  • Validate each web link (http 200 response?)
  • Validate each local link
    • If no valid local link is found, search within any given common parent (or use a passed directory as the parent), calculating string-similarity to determine a possible typo?
  • Per-file, report:
    • Broken web links
    • Broken local links (optionally with most likely similar file, if similarity above a threshold)

Readme

Dependencies

~10–22MB
~328K SLoC