fix: skip wrapping heading in callouts for non pragraph #1230
+21
−1
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
kellyjosephprice
approved these changes
Nov 10, 2025
kellyjosephprice
added a commit
that referenced
this pull request
Nov 11, 2025
[![PR App][icn]][demo] | Fix RM-XYZ :-------------------:|:----------: ## 🧰 Changes - In readme-to-mdx.ts, do more type checking when checking if a node is an h3 when visiting rdme-callout - Part of the fix is also included in #1230 where we skip wrapping callout children in heading if it's empty ## 🧬 QA & Testing - [Broken on production][prod]. - [Working in this PR app][demo]. --------- Co-authored-by: Kelly Joseph Price <[email protected]>
rafegoldberg
pushed a commit
that referenced
this pull request
Nov 11, 2025
## Version 11.7.0 ### ✨ New & Improved * migrate contents inside comments ([#1229](#1229)) ([60691dc](60691dc)) ### 🛠 Fixes & Updates * **deps:** bump tailwindcss from 4.1.16 to 4.1.17 ([#1231](#1231)) ([96343ae](96343ae)), closes [#19263](https://github.com/readmeio/markdown/issues/19263) [#19242](https://github.com/readmeio/markdown/issues/19242) [#19263](https://github.com/readmeio/markdown/issues/19263) [#19242](https://github.com/readmeio/markdown/issues/19242) [#19272](https://github.com/readmeio/markdown/issues/19272) [#19263](https://github.com/readmeio/markdown/issues/19263) [#19238](https://github.com/readmeio/markdown/issues/19238) * empty callouts erroring out ([#1232](#1232)) ([e740bfc](e740bfc)) * extract sections within custom components for TOC ([#1227](#1227)) ([615fe1b](615fe1b)) * skip wrapping heading in callouts for non pragraph ([#1230](#1230)) ([bcb0c0a](bcb0c0a)) * **deps-dev:** upgrading to vitest v4 ([#1222](#1222)) ([4fbaa3e](4fbaa3e)) <!--SKIP CI-->
Contributor
|
This PR was released!🚀 Changes included in v11.7.0 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
🧰 Changes
If a callout starts with an html element, the content gets dropped when migrated. I found that this is because in migrate-callouts.ts, we are wrapping the first children in a heading, assuming the node has a children attribute, and putting the children under the heading. However, the node might be an HTML node (or could be others) that don't have children, as a result the value gets dropped.
Current approach to fix is to avoid wrapping the node entirely if it's not a paragraph since the others won't have children.
🧬 QA & Testing
The mdx should retain the