Improve --exclude regular expression examples #1314
Labels
docs
Improvements or additions to documentation
good first issue
Good for newcomers
help wanted
Extra attention is needed
This is what the documentation has right now:
The URL I was attempting to exclude is an unusual case. It's from the generated HTML for a book that is discussing error handling for an invalid web address:
The URL appears several times in the file but never as part of an A HREF. The result is:
It took me a while to figure out how to ignore this.
--exclude a
would result in 567 Excluded and variations like^a
or^a$
didn't ignore it (based on the example in #1280). From the documentation, it wasn't clear that the solution was to add the scheme.The solution:
^https://a/$
Later I found this example in lychee.example.toml, which include the scheme in the regex:
Perhaps an additional example or a better example in the README would help?
I don't mind opening a PR for that (not for my specific example, but something like that linkedin example seems good). Before I do, I just wanted to double check that this is working as intended?
The text was updated successfully, but these errors were encountered: