This repository was archived by the owner on Mar 13, 2025. It is now read-only.
docs: render markdown links correctly inside <details> blocks #66
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
Some Markdown engines fail to render inline elements (like links and code formatting) inside `<details>` tags due to missing newlines after `<summary>`. This fix replaces the Markdown-style link with an HTML `<a>` tag, ensuring consistent rendering across different platforms.
👷 Deploy request for peaceful-bassi-cbf284 pending review.Visit the deploys page to approve it
|
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Closes: #65
Markdown links inside
<details>were not rendering correctly because there was no newline after<summary>. While adding a newline could fix this, it's fragile since it can be easily refactored out by mistake.Fix
Replaced the Markdown-style link:
with an HTML
<a>tag:This ensures the link renders correctly across while keeping the
<details>formatting intact.Why This Approach?
<summary>is unreliable and can break if refactored<a>tag ensures consistent rendering<details>Screenshots
Before
Now
