Reintroduce anchor detection as configurable step #25
Conversation
This file contains 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
aepfli
force-pushed
the
making_anchor_detection_configurable
branch
from
b52956e to
dc3c827
Compare
Anchor detection got removed during refactoring, as a link will still point to a sufficient url with a broken anchor, it still generates wrong/broken links. Especially when markdown is used to generate pages which are checked with tools like HTMLtest, which do verify proper anchors etc. Therefore i reintroduce this change with this pr, but as a configurable option. This should still allow the proper outcome of the refactoring, but ensures backwards compatibility for other users who rely on proper anchor handling. Relates: tcort#24 Signed-off-by: Simon Schrottner <[email protected]>
aepfli
force-pushed
the
making_anchor_detection_configurable
branch
from
dc3c827 to
34a545a
Compare
|
If this is a desirable change, I can also provide an update for https://github.com/tcort/markdown-link-check |
aepfli
commented
Jan 12, 2023
| @@ -3,13 +3,33 @@ | |||
| const { marked } = require('marked'); | |||
| const htmlLinkExtractor = require('html-link-extractor'); | |||
|
|
|||
| module.exports = function markdownLinkExtractor(markdown, extended = false) { | |||
| module.exports = function markdownLinkExtractor(markdown, checkAnchors = false) { | |||
There was a problem hiding this comment.
Alternatively, we could pass in an Object. This way, we don't confuse people who have been used to extended - and we're future-proof to provide more configuration options.
|
seems like tcort/markdown-link-check#212 would be solved by this |
|
Hi @tcort , can we have a new release that includes this PR to support anchor detection again? Thank you for this awesome project! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Anchor detection got removed during refactoring, as a link will still point to a sufficient URL with a broken anchor. It still generates wrong/broken links, especially when markdown is used to generate pages that are checked with tools like HTMLtest, which verify proper anchors etc.
So, I reintroduce this change with this pr but as a configurable option. This should still allow the proper outcome of the refactoring but ensures backward compatibility for other users who rely on proper anchor handling.
Relates: #24
Signed-off-by: Simon Schrottner [email protected]