fix: preserve <br> line breaks in fenced code - #1
Merged
Conversation
Signed-off-by: Matthias Lechner <matlec.public@gmail.com>
✅ Deploy Preview for margo-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
5 tasks
phil-abb
approved these changes
Jul 23, 2026
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
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.
@phil-abb's review comment on my PR revealed an issue with how we handle
<br>when assembling content for the site.Summary
The content sync deletes every
<br>from Markdown before the MDX build (sed 's/<br>//g'). Inside mermaid diagrams a<br>is a real line break, so a label likeGET /api/v1/deploymentsfollowed byHeader: If-None-Match: "sha256:abc..."renders as one run of text on the site.Change
Replace the blanket delete with a pass that depends on context. Inside fenced code, self-close
<br>so mermaid keeps its breaks. Everywhere else, strip it as before: a bare<br>is invalid JSX, and in a heading it becomes arawnode that crashes fumadocs'rehypeToc. This also drops the macOS/Linuxsed -isplit, sinceawkis portable.Verification
I ran the sync and dev server against a branch that uses
<br>in a mermaid diagram. The diagram renders with line breaks.