Repository navigation
π 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 directoryfor 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.