Hopiu/lychee
1
0
Fork 0
mirror of https://github.com/Hopiu/lychee.git synced 2026-03-16 20:50:25 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
⚡ Fast, async, stream-based link checker written in Rust. Finds broken URLs and mail addresses inside Markdown, HTML, reStructuredText, websites and more!
31 commits 1 branch 0 tags 5.1 MiB
Rust 98.6%
Dockerfile 0.7%
Nix 0.3%
Makefile 0.3%
Shell 0.1%
Find a file
Matthias Endler 1566a99647 Use CheckStatus enum for more fine-grained control over check results
2020-08-12 12:36:05 +02:00
.github/workflows Create rust.yml 2020-08-08 00:09:48 +02:00
assets Add logging and proper URL parsing 2020-08-07 19:00:21 +02:00
fixtures Add more links 2020-08-09 22:43:11 +02:00
src Use CheckStatus enum for more fine-grained control over check results 2020-08-12 12:36:05 +02:00
.gitignore Extract from hello-rust/show repository 2020-08-05 00:32:37 +02:00
Cargo.lock Use CheckStatus enum for more fine-grained control over check results 2020-08-12 12:36:05 +02:00
Cargo.toml Use CheckStatus enum for more fine-grained control over check results 2020-08-12 12:36:05 +02:00
README.md Update docs 2020-08-11 22:49:54 +02:00

README.md

lychee

Rust

...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
  • SOON: automatically retry and backoff
  • SOON: optionally ignore SSL certificate errors
  • SOON: optionally handle redirects

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.