lychee/README.md

...because who says I can't write yet another link checker.

What?

This thing was created from Hello Rust Episode 10. It's a link checker that treats Github links specially by using a GITHUB_TOKEN to avoid getting blocked less by the rate limiter.

Why?

The existing link checkers were not flexible enough for my use-case. lychee can...

• run fully asynchronously
• handle links inside unstructured (e.g. non-Markdown) documents
• handle chunked encodings
• handle gzip compression
• fake user agents (required for some firewalls)
• skip non-links like anchors or relative URLs
• exclude some websites with regular expressions
• handle a configurable number of redirects
• SOON: automatically retry and backoff
• SOON: optionally ignore SSL certificate errors

How?

cargo install lychee

Set an environment variable with your token like so GITHUB_TOKEN=xxxx.

Run it inside a repository with a README.md or specify a different Markdown file with

lychee --input <yourfile.md>

Thanks

...to my Github sponsors and Patreon sponsors for supporting these projects. If you want to help out as well, go here.