Skip to content

SwingFX-Markdown-Preview v1.0.0

Latest
Compare
Choose a tag to compare
@raghul-tech raghul-tech released this 06 Jul 07:52
· 1 commit to main since this release

πŸŽ‰ SwingFX Markdown Preview v1.0.0

πŸ“¦ Installation

Maven

<!-- All-in-one (recommended) -->
<dependency>
  <groupId>io.github.raghul-tech</groupId>
  <artifactId>swingfx-markdown-preview-all</artifactId>
  <version>1.0.0</version>
</dependency>

<!-- Core only -->
<dependency>
  <groupId>io.github.raghul-tech</groupId>
  <artifactId>swingfx-markdown-preview</artifactId>
  <version>1.0.0</version>
</dependency>

<!-- With Flexmark -->
<dependency>
  <groupId>io.github.raghul-tech</groupId>
  <artifactId>swingfx-markdown-preview-flexmark</artifactId>
  <version>1.0.0</version>
</dependency>

Gradle

implementation 'io.github.raghul-tech:swingfx-markdown-preview-all:1.0.0'

✨ Features

πŸ–₯️ Preview Components

Component Description
MarkdownPanel Embeddable JPanel preview
MarkdownTab Tabbed interface for JTabbedPane
MarkdownWindow Standalone preview window
MarkdownRenderer Headless HTML generator

🌈 Key Features

  • βœ… Real-time Markdown rendering

  • πŸŒ“ Light/dark theme support

  • πŸ”„ Live file monitoring

  • 🎨 GitHub-flavored styling

  • 😊 Emoji support (:smile:)

  • πŸ“ File & string content sources


πŸš€ Quick Start

// Create window preview
MarkdownWindow preview = new MarkdownWindow(new File("README.md"));
preview.launchPreview();
// Embed in panel
MarkdownPanel panel = new MarkdownPanel("# Hello World");
frame.add(panel);

πŸ“š Documentation

Javadocs

Examples Folder

Contributing Guide


πŸ†• Changelog

v1.0.0 Initial Release

  • Three module variants:

    • Core (minimal)
    • Flexmark edition
    • All-in-one bundle
  • Complete theme support (light/dark)

  • File monitoring system (auto-reload)

  • Clean resource disposal


πŸ“œ License