docs: remove broken gfm alert #16902
Merged
Conversation
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
|
Thanks for this! Unfortunately I don't know of a workaround. The rehype-github-alert package that we're using only transforms top-level blockquotes; wrapping the blockquote in any non-root parent element will cause an early return: https://github.com/rehypejs/rehype-github/blob/d602dab29fab941943a14b27d801b18f446636ee/packages/alert/lib/index.js#L60-L69 |
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.
It looks like GFM does not respect the
![]alert syntax when it's enclosed within a div. This is true for both the coder.com GFM renderer, and GitHub's (though I assume they're the same internally).When the section is surrounded by a
<div class="tabs">:When it's not:
Presumably same deal on Coder.com:
In our case, we really want the tabs, and the alert block is less important, so we'll downgrade it to a regular quote.
cc @aqandrew for visibility, in case you're aware of a workaround. Merging this for now to remove the broken line.