Conversation
Docusaurus's broken-link checker collects links via the theme's <Link>
component during render, regardless of CSS visibility, so links inside
content hidden with class="github-only" or style={{display: 'none'}}
(meant only for GitHub's markdown viewer) were flagged as broken.
Add a remark plugin that unwraps links found inside those hidden divs
before they become <a>/<Link> elements, so they're never collected.
Handles both the current inline-style pattern and the github-only class
repos are migrating to.
✅ Deploy Preview for cai-open-source ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
|
🚀 Deployed on https://deploy-preview-399--cai-open-source.netlify.app |
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
1 participant
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.
remark-strip-hidden-links.js, a remark plugin that walks the markdown AST and unwraps (removes the hyperlink, keeps the text) any links found inside a<div class="github-only">or<div style={{display: 'none'}}>block, before they're ever turned into links. This eliminates broken link warnings for stuff that is only displayed in the GitHub web interface (not Docusaurus).