Skip to content

Releases: raghul-tech/JavaFX-Markdown-Preview

JavaFX-Markdown-Preview v1.0.3

09 Jul 18:16
Compare
Choose a tag to compare

📦 JavaFX Markdown Preview 1.0.3 – Stable Multi-Module Release

✅ This release replaces 1.0.2, which included new features but failed deployment to Maven Central.

🚀 What's New

✨ Feature Highlights (from 1.0.2)

  • 🎯 Tab and TabPane Support – Easily embed previews in tabbed editors.

  • 🧩 Standalone WebView Component – Use previews in any JavaFX layout (VBox, BorderPane, etc).

  • 🌈 Enhanced GitHub-style Themes – Improved visuals for both light and dark mode.

  • 📝 Syntax Highlighting with Copy Button – Code blocks are now prettier and more interactive.

  • ⚡ Real-Time Updates – Instant preview refresh on file changes.

  • 💡 JavaFX 17 Compatibility – Supports Java 11+ via OpenJFX.


🧱 Build & Deployment

✅ Improvements in 1.0.3:

  • 📦 Sources & Javadocs attached for all artifacts.

  • 🧼 Cleaner, modular structure with consistent parent-child packaging.

  • 🔗 Added project metadata, license info, and developer details for Maven Central compliance.

  • 🛠️ Improved Maven plugin setup and GPG signing stability.


🐞 Bug Fixes

  • 🔧 Fixed incomplete .jar publishing in version 1.0.2.

  • 🧪 Resolved plugin errors during source/javadoc generation.

  • 🎯 Fixed packaging issues with shaded modules.


⚠️ Note

Version 1.0.2 introduced the features listed above, but was never successfully deployed.
Please use 1.0.3 as the first stable release with working Maven Central deployment.


📚 Quick Links

JavaFX-Markdown-Preview v1.0.2

09 Jul 13:33
Compare
Choose a tag to compare

📦 JavaFX Markdown Preview v1.0.2

Release Date: 2025-07-09

✨ Added

  • Tab and TabPane Integration

    • Simplified APIs to embed previews directly inside TabPane.

    • MarkdownTab now supports relaunchTab() and improved lifecycle management.

  • Standalone WebView Component

    • New class returning a WebView node you can embed anywhere (VBox, HBox, BorderPane, etc.).
  • Syntax Highlighting

    • Code blocks now render with automatic syntax highlighting.
  • Copy Button

    • One-click copy buttons added to all code blocks.
  • Improved Dark and Light Themes

    • Visual styles more closely match GitHub Markdown.
  • Enhanced Real-Time Updates

    • File changes reflect instantly without flicker.
  • MarkdownRenderer Enhancements

    • Added ability to export styled HTML.
  • Example Projects

    • Added multiple examples demonstrating:

      • Scene embedding

      • Stage embedding

      • VBox embedding

      • TabPane integration

      • Custom WebView usage


🛠️ Improved

  • 🪄 Window Launch Logic

    • More reliable lifecycle—no crashes when reopening windows.
  • Performance

    • Faster initial rendering and reduced memory usage with large Markdown files.
  • 🧹 Refactoring

    • Clear separation between:

      • javafx-markdown-preview (minimal core)

      • javafx-markdown-preview-all (with Flexmark and sources)

  • 🪟 Window Customization

    • Easier configuration of window title, size, and icons.
  • 🎯 Compatibility

    • Switched from JavaFX 23 to JavaFX 17 for broader Java 11+ support.

🧩 Artifacts

  • 🏷️ javafx-markdown-preview

    • Minimal build (requires you to add Flexmark).
  • 🏷️ javafx-markdown-preview-all

    • Bundled version including Flexmark and example sources.

🐞 Fixed

  • 🐛 Dark/light theme switching issues.

  • 🐛 Occasional NullPointerException when re-adding MarkdownTab.

  • 🐛 Encoding problems in previews with special characters.


⚖️ License Change

  • License updated:

    • From: MIT

    • To: GNU General Public License v3 (GPL-3.0)

This change ensures contributions remain open-source while allowing broader usage.


💡 Tip

You can now embed the WebView-based preview in any JavaFX Node for maximum flexibility.

JavaFX-Markdown-Preview v1.0.1

12 Jun 20:37
Compare
Choose a tag to compare

📦 Release v1.0.1 – Full Markdown Support for Java & JavaFX 🎉
Release Date: June 12, 2025
Tag: v1.0.1

✨ What's New
✅ Full Markdown Rendering Support
Powered by Flexmark, this release enables accurate and flexible Markdown rendering in your Java or JavaFX applications.

📂 Support for Both File & String Input
Seamlessly preview Markdown from either a .md file or a raw Markdown string — fits static and dynamic content needs.

🔄 Auto-Refresh on File Change
Real-time preview with automatic reloading when the source file is modified.

🖥️ Standalone JavaFX Window
Renders in an independent JavaFX window that can be reopened anytime if closed.

☕ Works with Pure Java or JavaFX Projects
Easily integrates with both traditional Java apps or UI-driven JavaFX environments.

🛠 Enhancements
Clean modular codebase for easy extension and reuse.

Improved error handling and reload logic for a better user experience.

📦 Dependency (Maven)
Add this to your pom.xml:

<dependency>
  <groupId>io.github.raghul-tech</groupId>
  <artifactId>javafx-markdown-preview</artifactId>
  <version>1.0.1</version>
</dependency>

📚 Documentation
Explore the full API via the official Javadoc.