Skip to content

Commit 0978d33

Browse files
authored
Create README.md
1 parent 46ee3d1 commit 0978d33

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# JavaFX Markdown Preview
2+
3+
A reusable and lightweight JavaFX-based Markdown preview component built with Flexmark and JavaFX WebView. Ideal for developers who want to integrate a live Markdown renderer into their Java desktop applications.
4+
5+
## ✨ Features
6+
7+
- 📄 Markdown to HTML rendering using [Flexmark](https://github.com/vsch/flexmark-java)
8+
- 🖥️ JavaFX WebView for previewing
9+
- ⚡ Fast and minimal setup
10+
- 🎯 Easy to embed in any JavaFX application
11+
12+
## 📦 Installation
13+
14+
You can include it in your Maven project (after it's published to Maven Central):
15+
16+
```xml
17+
<dependency>
18+
<groupId>io.github.raghul-tech</groupId>
19+
<artifactId>javafx-markdown-preview</artifactId>
20+
<version>1.0.0</version>
21+
</dependency>

0 commit comments

Comments
 (0)