Repository navigation
Extend --include-fragments docu #2278 - #2281
Merged
Merged
Conversation
A first draft, including the info I would want to see
katrinafyi
reviewed
Aug 10, 2026
katrinafyi
left a comment
katrinafyi
left a comment
Member
There was a problem hiding this comment.
If you have it checked out locally, you can run make readme to generate the new README text and fix the failing test. If not let me know and I can do it.
Comment on lines
+522
to
+531
| /// This check will not work on all URLs. | ||
| /// The rough requirements are, that the target content be Markdown or HTML, | ||
| /// and that it follows certain, common conventions. | ||
| /// If for example JavaScript needs to be executed | ||
| /// to get to the actual HTML content that might contain the anchor, | ||
| /// the check will not see the anchor (e.g. report a miss), | ||
| /// as this scenario would require running this checker to run a browser engine, | ||
| /// which would make it orders of magnitude heavier on computing resources. | ||
| /// More info about this check can be found here: | ||
| /// <https://lychee.cli.rs/recipes/anchors/> |
Member
There was a problem hiding this comment.
Makes sense. I shortened it a bit because we don't have to justify ourself in the help text. I think this limitation is very reasonable and unsurprising.
I also don't feel a strong need to list markdown + HTML. id attributes are fundamentally a HTML thing so other file types don't usually make sense. We support Markdown because Markdown is often converted to HTML. It's also in the linked page, but if you feel strongly about this it can be added back.
Suggested change
| /// This check will not work on all URLs. | |
| /// The rough requirements are, that the target content be Markdown or HTML, | |
| /// and that it follows certain, common conventions. | |
| /// If for example JavaScript needs to be executed | |
| /// to get to the actual HTML content that might contain the anchor, | |
| /// the check will not see the anchor (e.g. report a miss), | |
| /// as this scenario would require running this checker to run a browser engine, | |
| /// which would make it orders of magnitude heavier on computing resources. | |
| /// More info about this check can be found here: | |
| /// <https://lychee.cli.rs/recipes/anchors/> | |
| /// If enabled, this check will only succeed if the anchors exist in the | |
| /// static content of the target page (e.g., it will not run JavaScript). | |
| /// See also: <https://lychee.cli.rs/recipes/anchors/> |
mre
reviewed
Aug 10, 2026
as suggested by @mre Co-authored-by: Matthias Endler <[email protected]>
mre
approved these changes
Aug 11, 2026
Member
|
Thanks for the contribution @hoijui. |
Contributor
Author
|
Thank you for the tool and the process; was a pleasure! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
A first draft, including the info I would want to see