Skip to content

Conversation

@michelroegl-brunner
Copy link
Member

Summary

This PR improves the release notes modal by replacing plain text rendering with proper markdown parsing and formatting.

Changes

  • Added Dependencies:

    • for markdown parsing
    • for GitHub-flavored markdown support
    • for prose styling
  • Enhanced Release Notes Rendering:

    • Headers (##) now render with proper sizing and hierarchy
    • Lists display with bullets and proper indentation instead of raw symbols
    • Links are clickable and styled appropriately
    • Emojis (🚀, 🐛) render correctly as colored icons
    • Bold/italic text formatting works properly
    • Maintains dark mode compatibility

Before/After

Before: Raw markdown syntax was displayed as plain text with
After: Properly formatted markdown with visual hierarchy, styled lists, and clickable links

Testing

  • Release notes modal displays with improved formatting
  • All markdown elements render correctly
  • Dark mode styling is preserved
  • Links open in new tabs with proper security attributes

- Add react-markdown and remark-gfm for proper markdown parsing
- Add @tailwindcss/typography plugin for prose styling
- Replace plain text rendering with custom ReactMarkdown components
- Headers now render with proper sizing and hierarchy
- Lists display with bullets and proper indentation
- Links are clickable and styled appropriately
- Emojis render correctly
- Maintain dark mode compatibility
@michelroegl-brunner michelroegl-brunner requested a review from a team as a code owner October 14, 2025 13:52
@michelroegl-brunner michelroegl-brunner merged commit 67ac02e into main Oct 14, 2025
4 checks passed
@michelroegl-brunner michelroegl-brunner changed the title feat: improve release notes markdown rendering refactor: improve release notes markdown rendering Oct 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants