fix(markdown): Always render noteblock titles on its own line #11548
+13
−13
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.
Summary
This PR updates the GFM noteblock rendering to always put the title ("Note:", "Warning:", etc.) on its own line, regardless of how the Markdown is formatted.
Important
GitHub has named noteblocks as "Alerts".
Problem
One issue that is currently preventing us from performing mass GFM noteblock conversion is a Prettier bug, which causes lines starting with special characters (like [ or `) to get wrapped to the same line as the noteblock declaration (like
> [!NOTE] > `code` cannot be used
).Solution
The simplest solution I could think of was to update the rendering to be more similar to how GitHub renders its noteblocks.
Note
This is how GitHub's noteblocks look.
Screenshots
Test Markdown
Before
After