Render nested markup inside headings in HTMLFormatter#280
Merged
Conversation
d-ronnqvist
reviewed
Jun 30, 2026
d-ronnqvist
requested changes
Jun 30, 2026
Contributor
|
@swift-ci please test |
d-ronnqvist
approved these changes
Jul 1, 2026
jackbolen
added a commit
to jackbolen/swift-markdown
that referenced
this pull request
Jul 19, 2026
Upstream swiftlang#274 (visitText/visitInlineCode/visitCodeBlock escape &<> through String.htmlEscaped()) and swiftlang#280 (visitHeading descends into nested markup) land byte-for-byte so the next upstream merge is clean. Fork delta on top: attribute positions — link href, image src/title, footnote ids/hrefs, and data-attributes — route through a quote-escaping attribute wrapper, since upstream's 3-character text helper cannot serve a double-quoted attribute; data-attributes drops its invalid backslash-escaped quote for ". Math text moves onto htmlEscaped() (a quote needs no escape in text position).
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
2 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.
Bug/issue #, if applicable: Fixes #262
Summary
HTMLFormatter.visitHeading(:) rendered headings using heading.plainText, which stripped all nested inline markup. As a result, links, emphasis, strong text, inline code, and other inline elements inside headings were lost in the generated HTML. Updated HTMLFormatter.visitHeading(:) to render a heading's child markup by descending into its children instead of using heading.plainText.
Dependencies
N/A
Testing
Added regression tests covering:
Steps:
Run HTMLFormatterTests
Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
./bin/testscript and it succeeded