Hopiu/lychee
1
0
Fork 0
mirror of https://github.com/Hopiu/lychee.git synced 2026-03-17 05:00:26 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
lychee/README.md
Matthias Endler 12e978224d Update
2020-08-09 22:56:54 +02:00

1.1 KiB
Raw Blame History

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 by the bot protection.

Why?

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

  • Handle chunked encodings
  • Handle gzip
  • Fake user agents (required for some firewalls)
  • Skip non-links like anchors or relative URLs
  • SOON: Ignore SSL certificate errors
  • SOON: fully async code execution

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.