Issues checking anchors/fragments in markdown files
f-hollow opened this issue · comments
The README claims that lychee
supports Anchors/Fragments
.
My README.md
is as follows:
# Test lychee
## Anchor
This is a section I am trying to link to.
## Another section
You can find the _Anchor_ section [here](#ancho).
Running lychee
on this README.md
returns this:
$ lychee README.md
1/1 ━━━━━━━━━━━━━━━━━━━━ Finished extracting links
🔍 1 Total (in 0s) ✅ 1 OK 🚫 0 Errors
Apparently, the link [here](#ancho)
is faulty. The correct link would be [here](#anchor)
.
Am I doing anything wrong?
I look forward to successfully resolving this issue as I really need a tool that can check markdown anchors for issues like given above.
Can you try this?
lychee --include-fragments README.md
Ah, sorry! I assumed all the features listed in the table would work out of the box.
Now the link checking works perfectly. Exactly what I was looking for!
It might be worthwhile to add in the Features section that some features are disabled by default and can be activated using respective command-line arguments. But maybe it's just my problem.
Then I will close this issue. Thank you!
True. The question is how to phrase it or where to put the description to avoid confusing the reader.
Perhaps we could mention it in the lychee docs (https://lychee.cli.rs/) somewhere. Pull requests welcome in case you have an idea. The repo is here: https://github.com/lycheeverse/lycheeverse.github.io
In the meantime, I'm happy that this resolved your problem.