[PR #148] [MERGED] refactor: improve release notes markdown rendering #215

Closed
opened 2025-11-20 04:13:34 -05:00 by saavagebueno · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/community-scripts/ProxmoxVE-Local/pull/148
Author: @michelroegl-brunner
Created: 10/14/2025
Status: Merged
Merged: 10/14/2025
Merged by: @michelroegl-brunner

Base: mainHead: refactor/readme_modal


📝 Commits (1)

  • a4fb12b feat: improve release notes markdown rendering

📊 Changes

4 files changed (+1435 additions, -85 deletions)

View changed files

📝 package-lock.json (+1413 -83)
📝 package.json (+3 -0)
📝 src/app/_components/ReleaseNotesModal.tsx (+18 -2)
📝 src/styles/globals.css (+1 -0)

📄 Description

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

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/community-scripts/ProxmoxVE-Local/pull/148 **Author:** [@michelroegl-brunner](https://github.com/michelroegl-brunner) **Created:** 10/14/2025 **Status:** ✅ Merged **Merged:** 10/14/2025 **Merged by:** [@michelroegl-brunner](https://github.com/michelroegl-brunner) **Base:** `main` ← **Head:** `refactor/readme_modal` --- ### 📝 Commits (1) - [`a4fb12b`](https://github.com/community-scripts/ProxmoxVE-Local/commit/a4fb12b3c43932bb7eecec38c3b5b2fe198f85d2) feat: improve release notes markdown rendering ### 📊 Changes **4 files changed** (+1435 additions, -85 deletions) <details> <summary>View changed files</summary> 📝 `package-lock.json` (+1413 -83) 📝 `package.json` (+3 -0) 📝 `src/app/_components/ReleaseNotesModal.tsx` (+18 -2) 📝 `src/styles/globals.css` (+1 -0) </details> ### 📄 Description ## 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 --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
saavagebueno added the pull-request label 2025-11-20 04:13:34 -05:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: SVI/ProxmoxVE-Local#215