Add markdown support for release notes#2810
Merged
Conversation
Fix markdown detection for external release note links too.
Also make paragraph spacing proportional to font size.
We just need to render through entire vertical bounds and don't need to calculate number of lines.
Format markdown attributed text all on a background thread now.
This was referenced Dec 19, 2025
6 tasks
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.
This adds markdown support to Sparkle's release notes. Similar to plain-text release notes, this allows using releasing notes in applications that aren't able to use WKWebView (e.g. Catalyst apps and apps without an outgoing network client entitlement which use the Downloader XPC Service). Other apps may also adopt markdown due to simplicity, although note it's not as expressive as HTML/CSS.
Other details:
sparkle:format="markdown"option to<description>element for embedded release notes (in addition to already existingsparkle:format="plain-text"option)Decorative rendering for block quotes and thematic breaks was experimented through three ways (NSTextAttachmentCell, NSTextAttachmentViewProvider, NSTextViewportLayoutControllerDelegate). In the end I decided the complexity, risk, compatibility tradeoffs of these were not worthwhile enough, and I figure these are not critical to many change logs.
Fixes #2319
Misc Checklist
Testing
I tested and verified my change by using one or multiple of these methods:
Tested markdown support in Sparkle Test App, in other app using macOS Catalyst.
macOS version tested:
26.2 (25C56)
12.0 VM (at an earlier revision, I'll test this again at a later point).