Skip to content

v1.0.0

Latest
Compare
Choose a tag to compare
@raghul-tech raghul-tech released this 03 Jul 12:52
· 3 commits to main since this release
ad3202b

πŸŽ‰ 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 a JPanel.
    • SwingMarkdownScrollPanePreview – Embed as a JScrollPane.
    • SwingMarkdownWindowPreview – Display in a standalone window.
    • SwingMarkdownTabbedPreview – Add preview tabs to your JTabbedPane.
  • βœ… 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.