fix(stripComments): preserve tabbed code blocks #1250
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
kevinports
commented
Dec 5, 2025
Comment on lines
+40
to
+47
| join: [ | ||
| // Preserve tight sibling code blocks without adding extra newlines between them. | ||
| // Our markdown renderer uses this to group these code blocks into a tabbed interface. | ||
| (left, right) => { | ||
| // 0 = no newline between blocks | ||
| return (left.type === 'code' && right.type === 'code') ? 0 : undefined; | ||
| }, | ||
| ], |
Contributor
Author
There was a problem hiding this comment.
dannobytes
approved these changes
Dec 5, 2025
Contributor
dannobytes
left a comment
dannobytes
left a comment
There was a problem hiding this comment.
so long as that test case passes, lgtm! thanks for the quick fix.
i know we both had a feeling that we'd be incrementally adding more test cases as they come in for these edge-cases.
and this is due to this tabbed feature being another readme-flavored syntax right?
Comment on lines
+40
to
+47
| join: [ | ||
| // Preserve tight sibling code blocks without adding extra newlines between them. | ||
| // Our markdown renderer uses this to group these code blocks into a tabbed interface. | ||
| (left, right) => { | ||
| // 0 = no newline between blocks | ||
| return (left.type === 'code' && right.type === 'code') ? 0 : undefined; | ||
| }, | ||
| ], |
Contributor
Author
yep thats correct |
rafegoldberg
pushed a commit
that referenced
this pull request
Dec 5, 2025
## Version 11.8.0 ### ✨ New & Improved * **mdxish:** add new MDXish engine ([#1243](#1243)) ([9e8f85f](9e8f85f)), closes [/github.com//pull/1243#discussion_r2587081529](https://github.com/readmeio//github.com/readmeio/markdown/pull/1243/issues/discussion_r2587081529) ### 🛠 Fixes & Updates * **stripComments:** preserve tabbed code blocks ([#1250](#1250)) ([64e58ce](64e58ce)) <!--SKIP CI-->
Contributor
|
This PR was released!🚀 Changes included in v11.8.0 |
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.
Akamai has a rendering issue with broken code tabs when their "Sanitize Comments" flag is enabled
Our
stripCommentsfunction converts md -> mdast, removes comments, then serializes mdast -> md usingremarkStringify-- which by default adds one blank line between any two flow (“block”) nodes.But a feature of our markdown renderer is to take any code blocks flush next to each other and turn them into a tabbed interface:
So we need to retain this formatting in
stripComments!🧰 Changes
🧬 QA & Testing