Skip to content

Commit 8db9084

Browse files
committed
v1.0.2
1 parent bf3eeb9 commit 8db9084

File tree

58 files changed

+5134
-1346
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

58 files changed

+5134
-1346
lines changed

.github/ISSUE_TEMPLATE/bug_report.yaml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,20 @@
1+
# Copyright (C) 2025 Raghul-tech
2+
# https://github.com/raghul-tech
3+
# This file is part of JavaFX Markdown Preview.
4+
#
5+
# JavaFX Markdown Preview is free software: you can redistribute it and/or modify
6+
# it under the terms of the GNU General Public License as published by
7+
# the Free Software Foundation, either version 3 of the License, or
8+
# (at your option) any later version.
9+
#
10+
# JavaFX Markdown Preview is distributed in the hope that it will be useful,
11+
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12+
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13+
# GNU General Public License for more details.
14+
#
15+
# You should have received a copy of the GNU General Public License
16+
# along with JavaFX Markdown Preview. If not, see <https://www.gnu.org/licenses/>.
17+
118
name: 🐞 Bug Report
219
description: Create a report to help us improve
320
title: "[Bug] <Short description of the bug>"

.github/workflows/codeql.yml

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,21 @@
1+
# Copyright (C) 2025 Raghul-tech
2+
# https://github.com/raghul-tech
3+
# This file is part of JavaFX Markdown Preview.
4+
#
5+
# JavaFX Markdown Preview is free software: you can redistribute it and/or modify
6+
# it under the terms of the GNU General Public License as published by
7+
# the Free Software Foundation, either version 3 of the License, or
8+
# (at your option) any later version.
9+
#
10+
# JavaFX Markdown Preview is distributed in the hope that it will be useful,
11+
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12+
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13+
# GNU General Public License for more details.
14+
#
15+
# You should have received a copy of the GNU General Public License
16+
# along with JavaFX Markdown Preview. If not, see <https://www.gnu.org/licenses/>.
17+
18+
119
name: CodeQL Analysis
220

321
on:
@@ -34,7 +52,7 @@ jobs:
3452
- name: Set up JDK
3553
uses: actions/setup-java@v3
3654
with:
37-
java-version: '23'
55+
java-version: '17'
3856
distribution: 'temurin'
3957

4058
- name: Build project with Maven (GPG disabled)

.github/workflows/maven.yml

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,21 @@
1+
# Copyright (C) 2025 Raghul-tech
2+
# https://github.com/raghul-tech
3+
# This file is part of JavaFX Markdown Preview.
4+
#
5+
# JavaFX Markdown Preview is free software: you can redistribute it and/or modify
6+
# it under the terms of the GNU General Public License as published by
7+
# the Free Software Foundation, either version 3 of the License, or
8+
# (at your option) any later version.
9+
#
10+
# JavaFX Markdown Preview is distributed in the hope that it will be useful,
11+
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12+
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13+
# GNU General Public License for more details.
14+
#
15+
# You should have received a copy of the GNU General Public License
16+
# along with JavaFX Markdown Preview. If not, see <https://www.gnu.org/licenses/>.
17+
18+
119
name: Maven Build
220

321
on:
@@ -17,7 +35,7 @@ jobs:
1735
- name: Set up JDK
1836
uses: actions/setup-java@v3
1937
with:
20-
java-version: '23'
38+
java-version: '17'
2139
distribution: 'temurin'
2240

2341
- name: Import GPG key

CHANGELOG.md

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,95 @@
1+
<!--
2+
* Copyright (C) 2025 Raghul-tech
3+
* https://github.com/raghul-tech
4+
* This file is part of JavaFX Markdown Preview.
5+
*
6+
* JavaFX Markdown Preview is free software: you can redistribute it and/or modify
7+
* it under the terms of the GNU General Public License as published by
8+
* the Free Software Foundation, either version 3 of the License, or
9+
* (at your option) any later version.
10+
*
11+
* JavaFX Markdown Preview is distributed in the hope that it will be useful,
12+
* but WITHOUT ANY WARRANTY; without even the implied warranty of
13+
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14+
* GNU General Public License for more details.
15+
*
16+
* You should have received a copy of the GNU General Public License
17+
* along with JavaFX Markdown Preview. If not, see <https://www.gnu.org/licenses/>.
18+
-->
19+
120
# 📦 Changelog
221

322
All notable changes to **JavaFX Markdown Preview** will be documented in this file.
423

524
---
625

26+
## [1.0.2] - 2025-07-09
27+
28+
### ✨ Added
29+
-**Tab and TabPane Integration**
30+
- Simplified APIs to embed previews directly inside `TabPane`.
31+
- Improved `MarkdownTab` to support `relaunchTab()` and enhanced lifecycle management.
32+
-**Standalone WebView Component**
33+
- Introduced a new class that returns a `WebView` node, allowing you to embed previews **anywhere** in your JavaFX layouts (e.g., `VBox`, `HBox`, `BorderPane`).
34+
-**Syntax Highlighting**
35+
- Code blocks now automatically use syntax highlighting.
36+
-**Copy Button**
37+
- Added a convenient copy button for all code blocks in the preview.
38+
-**Improved Dark and Light Themes**
39+
- Visual styles now more closely match GitHub Markdown rendering.
40+
-**Enhanced Real-Time Updates**
41+
- File changes are instantly reflected without flicker.
42+
-**MarkdownRenderer Enhancements**
43+
- Added ability to get **styled HTML** for exporting or embedding.
44+
-**Example Projects**
45+
- Added multiple example apps demonstrating:
46+
- Scene embedding
47+
- Stage embedding
48+
- VBox embedding
49+
- TabPane integration
50+
- Custom WebView integration
51+
52+
### 🛠️ Improved
53+
- 🪄 **Window Launch Logic**
54+
- More reliable lifecycle—no crashes when reopening windows.
55+
-**Performance**
56+
- Faster initial rendering and reduced memory usage with large Markdown files.
57+
- 🧹 **Refactoring**
58+
- Clear separation between:
59+
- **`javafx-markdown-preview`** (minimal core build)
60+
- **`javafx-markdown-preview-all`** (with Flexmark and full source)
61+
- 🪟 **Window Customization**
62+
- Easier configuration of window title, size, and icons.
63+
- 🎯 **Compatibility**
64+
- Switched from JavaFX 23 to **JavaFX 17** for better support across older Java versions (Java 11+).
65+
66+
### 🧩 Artifacts
67+
- 🏷️ **`javafx-markdown-preview`**
68+
- Minimal build with only essential classes.
69+
- 🏷️ **`javafx-markdown-preview-all`**
70+
- Bundled version including Flexmark and example sources.
71+
72+
### 🐞 Fixed
73+
- 🐛 Resolved dark/light theme switching issues.
74+
- 🐛 Fixed occasional `NullPointerException` when re-adding `MarkdownTab`.
75+
- 🐛 Corrected encoding problems in previews with special characters.
76+
77+
---
78+
79+
## ⚖️ License Change
80+
- 📝 **License updated**:
81+
- **From:** MIT
82+
- **To:** GNU General Public License v3 (GPL-3.0)
83+
84+
> This ensures contributions remain open-source while allowing broader usage.
85+
86+
---
87+
88+
## 💡 Tip
89+
- You can now use the **WebView-based preview in any JavaFX Node** (e.g., `VBox`, `StackPane`, `BorderPane`) for maximum flexibility.
90+
91+
---
92+
793
## [1.0.1] - 2025-06-12
894

995
### ✨ Added

CODE_OF_CONDUCT.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,22 @@
1+
<!--
2+
* Copyright (C) 2025 Raghul-tech
3+
* https://github.com/raghul-tech
4+
* This file is part of JavaFX Markdown Preview.
5+
*
6+
* JavaFX Markdown Preview is free software: you can redistribute it and/or modify
7+
* it under the terms of the GNU General Public License as published by
8+
* the Free Software Foundation, either version 3 of the License, or
9+
* (at your option) any later version.
10+
*
11+
* JavaFX Markdown Preview is distributed in the hope that it will be useful,
12+
* but WITHOUT ANY WARRANTY; without even the implied warranty of
13+
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14+
* GNU General Public License for more details.
15+
*
16+
* You should have received a copy of the GNU General Public License
17+
* along with JavaFX Markdown Preview. If not, see <https://www.gnu.org/licenses/>.
18+
-->
19+
120
# Code of Conduct
221

322
## 👋 Our Pledge

CONTRIBUTING.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,22 @@
1+
<!--
2+
* Copyright (C) 2025 Raghul-tech
3+
* https://github.com/raghul-tech
4+
* This file is part of JavaFX Markdown Preview.
5+
*
6+
* JavaFX Markdown Preview is free software: you can redistribute it and/or modify
7+
* it under the terms of the GNU General Public License as published by
8+
* the Free Software Foundation, either version 3 of the License, or
9+
* (at your option) any later version.
10+
*
11+
* JavaFX Markdown Preview is distributed in the hope that it will be useful,
12+
* but WITHOUT ANY WARRANTY; without even the implied warranty of
13+
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14+
* GNU General Public License for more details.
15+
*
16+
* You should have received a copy of the GNU General Public License
17+
* along with JavaFX Markdown Preview. If not, see <https://www.gnu.org/licenses/>.
18+
-->
19+
120
# 🙌 Contributing to JavaFX Markdown Preview
221

322
First off, thanks for taking the time to contribute! 🎉

0 commit comments

Comments
 (0)