Releases: raghul-tech/Swing-Markdown-Preview
Releases · raghul-tech/Swing-Markdown-Preview
v1.0.0
🎉 Swing Markdown Preview v1.0.0
The first stable release of Swing Markdown Preview, a lightweight Java library for rendering GitHub-flavored Markdown in Swing applications.
✨ Highlights
- ✅ Render Markdown to HTML using flexmark-java.
- ✅ Live preview components:
SwingMarkdownPanelPreview
– Embed as aJPanel
.SwingMarkdownScrollPanePreview
– Embed as aJScrollPane
.SwingMarkdownWindowPreview
– Display in a standalone window.SwingMarkdownTabbedPreview
– Add preview tabs to yourJTabbedPane
.
- ✅ Supports tables, task lists, strikethrough, and GitHub user mentions.
- ✅ Emoji rendering with fallback images (GitHub emoji CDN).
- ✅ Automatic dark and light theme styles.
🏗️ Components
Component | Purpose |
---|---|
SwingMarkdownPanelPreview |
Use as a panel in any container |
SwingMarkdownScrollPanePreview |
Use as a scrollable preview |
SwingMarkdownWindowPreview |
Launch in a separate window |
SwingMarkdownTabbedPreview |
Add previews as tabs in a JTabbedPane |
🚀 Getting Started
<dependency>
<groupId>io.github.raghul-tech</groupId>
<artifactId>swing-markdown-preview-all</artifactId>
<version>1.0.0</version>
</dependency>
🛠️ Example Usage
-
See the
examples directory
for sample code:-
Tabbed Preview
-
Standalone Window
-
Panel Embed
-
ScrollPane Embed
-
💡 Notes
-
Java 8+ compatible.
-
No additional native dependencies.
-
If you need help integrating into your project, open an issue or start a discussion.
Thank you for trying Swing Markdown Preview! 🙌
Your feedback is welcome to improve and shape future releases.