{"id":28854226,"url":"https://github.com/raghul-tech/javafx-markdown-preview","last_synced_at":"2026-02-01T12:34:33.002Z","repository":{"id":298704320,"uuid":"999701907","full_name":"raghul-tech/JavaFX-Markdown-Preview","owner":"raghul-tech","description":"⚡ JavaFX utility to preview Markdown in a separate window using Flexmark — perfect for developers building modern Java applications with live .md rendering support.","archived":false,"fork":false,"pushed_at":"2025-07-09T18:16:33.000Z","size":97,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-10-21T00:51:26.579Z","etag":null,"topics":["documentation","flexmark","java","javafx","javafx-components","javafx-utilities","markdown","markdown-preview","markdown-previewer","markdown-renderer","preview-tool"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/raghul-tech.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-06-10T16:49:26.000Z","updated_at":"2025-09-29T03:31:13.000Z","dependencies_parsed_at":"2025-06-12T12:46:50.390Z","dependency_job_id":"8ab8b203-7a36-4d23-9508-896fbcca1de7","html_url":"https://github.com/raghul-tech/JavaFX-Markdown-Preview","commit_stats":null,"previous_names":["raghul-tech/javafx-markdown-preview"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/raghul-tech/JavaFX-Markdown-Preview","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raghul-tech%2FJavaFX-Markdown-Preview","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raghul-tech%2FJavaFX-Markdown-Preview/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raghul-tech%2FJavaFX-Markdown-Preview/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raghul-tech%2FJavaFX-Markdown-Preview/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/raghul-tech","download_url":"https://codeload.github.com/raghul-tech/JavaFX-Markdown-Preview/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raghul-tech%2FJavaFX-Markdown-Preview/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28978176,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-01T12:13:08.691Z","status":"ssl_error","status_checked_at":"2026-02-01T12:13:08.356Z","response_time":56,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","flexmark","java","javafx","javafx-components","javafx-utilities","markdown","markdown-preview","markdown-previewer","markdown-renderer","preview-tool"],"created_at":"2025-06-19T22:09:24.204Z","updated_at":"2026-02-01T12:34:32.988Z","avatar_url":"https://github.com/raghul-tech.png","language":"Java","funding_links":["https://buymeacoffee.com/raghultech"],"categories":[],"sub_categories":[],"readme":"\u003c!--\n * Copyright (C) 2025 Raghul-tech\n * https://github.com/raghul-tech\n * This file is part of JavaFX Markdown Preview.\n *\n * JavaFX Markdown Preview is free software: you can redistribute it and/or modify\n * it under the terms of the GNU General Public License as published by\n * the Free Software Foundation, either version 3 of the License, or\n * (at your option) any later version.\n *\n * JavaFX Markdown Preview is distributed in the hope that it will be useful,\n * but WITHOUT ANY WARRANTY; without even the implied warranty of\n * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\n * GNU General Public License for more details.\n *\n * You should have received a copy of the GNU General Public License\n * along with JavaFX Markdown Preview.  If not, see \u003chttps://www.gnu.org/licenses/\u003e.\n--\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"img/MD.png\" alt=\"JavaFX Markdown Preview Banner\" width=\"150\" /\u003e\n\u003c/p\u003e\n\n\u003ch1 align=\"center\"\u003eJavaFX Markdown Preview\u003c/h1\u003e\n\u003cp align=\"center\"\u003e\n  \u003cstrong\u003e⚡ Fast. 🖼️ Beautiful. 🎯 Real-Time. 🌓 Theme-Aware.\u003c/strong\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n\n  \u003c!-- Maven Central --\u003e\n  \u003ca href=\"https://central.sonatype.com/artifact/io.github.raghul-tech/javafx-markdown-preview\"\u003e\n    \u003cimg src=\"https://img.shields.io/maven-central/v/io.github.raghul-tech/javafx-markdown-preview?style=for-the-badge\u0026color=blueviolet\" alt=\"Maven Central\" /\u003e\n  \u003c/a\u003e\n\n  \u003c!-- GitHub Release --\u003e\n  \u003ca href=\"https://github.com/raghul-tech/JavaFX-Markdown-Preview/releases\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/release/raghul-tech/JavaFX-Markdown-Preview.svg?label=Latest%20Release\u0026style=for-the-badge\u0026color=success\" alt=\"GitHub Release\" /\u003e\n  \u003c/a\u003e\n\n  \u003c!-- Maven Build Workflow --\u003e\n  \u003ca href=\"https://github.com/raghul-tech/JavaFX-Markdown-Preview/actions/workflows/maven.yml\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/actions/workflow/status/raghul-tech/JavaFX-Markdown-Preview/maven.yml?label=Build\u0026style=for-the-badge\u0026color=brightgreen\" alt=\"Maven Build Status\" /\u003e\n  \u003c/a\u003e\n\n  \u003c!-- CodeQL Analysis --\u003e\n  \u003ca href=\"https://github.com/raghul-tech/JavaFX-Markdown-Preview/actions/workflows/codeql.yml\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/actions/workflow/status/raghul-tech/JavaFX-Markdown-Preview/codeql.yml?label=CodeQL\u0026logo=github\u0026style=for-the-badge\u0026color=informational\" alt=\"CodeQL Status\" /\u003e\n  \u003c/a\u003e\n\n  \u003c!-- Javadoc --\u003e\n  \u003ca href=\"https://javadoc.io/doc/io.github.raghul-tech/javafx-markdown-preview/1.0.3\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/Javadoc-1.0.3-blue?style=for-the-badge\u0026logo=java\" alt=\"Javadoc (1.0.3)\" /\u003e\n  \u003c/a\u003e\n\n  \u003c!-- Support --\u003e\n  \u003ca href=\"https://buymeacoffee.com/raghultech\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/Buy%20Me%20a%20Coffee-Support-orange?style=for-the-badge\u0026logo=buy-me-a-coffee\" alt=\"Buy Me A Coffee\" /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\n\n---\n\n# ☕ About JavaFX Markdown Preview\n\n**JavaFX Markdown Preview** is a modern and lightweight library designed to render Markdown content seamlessly in JavaFX applications.\n\nWhether you’re building a Markdown editor, a documentation viewer, or just need a clean way to preview `.md` content inside your app — this tool saves you hours of work by offering a plug-and-play experience.\n\n### Why use this? \n\n✅ **Embed anywhere** – Tabs, windows, or any JavaFX layout  \n✅ **Live preview** – Automatic updates when files change  \n✅ **Syntax highlighting** – Beautiful, GitHub-style code blocks  \n✅ **Copy buttons** – One-click copy of code snippets  \n✅ **Dark and light themes** – Easy toggling  \n✅ **Markdown to HTML export** – Generate styled HTML  \n✅ **Cross-platform** – Windows, macOS, Linux  \n✅ **No browser dependency** – Uses JavaFX WebView\n\n\n\u003e Whether you're developing documentation tools, note-taking apps, IDE plugins, or just need a Markdown viewer, this tool offers a ready-made and customizable solution.\n\n---\n\n## ✨ What's New in 1.0.3\n\n\u003e**Note**:\n\u003e**Version 1.0.2** contained all the new features below but failed deployment to Maven Central.\n\u003e**Version 1.0.3** is the first properly signed and published release.\n\u003ePlease upgrade to **1.0.3**.\n\n- 🎯 **Tab and TabPane Support**\n  - Embed previews inside `TabPane` with lifecycle management.\n- 🧩 **Standalone WebView Component**\n  - Use a `WebView` node in any JavaFX layout (`VBox`, `HBox`, `BorderPane`).\n- 🌈 **Enhanced GitHub-Style Themes**\n  - Cleaner dark and light themes matching GitHub styling.\n- 📝 **Syntax Highlighting \u0026 Copy Buttons**\n  - Beautiful code blocks with one-click copy support.\n- ⚡ **Improved Real-Time Updates**\n  - Live reload when files change, with reduced flicker.\n- 💡 **JavaFX 17 Compatibility**\n  - Runs smoothly on JavaFX 11–17.\n\n✅ **Why use 1.0.3?** \n\u003eThis version ensures a verified signature, successful publication to Maven Central, and fully reproducible builds.\n\n---\n\n## 📦 Available Modules\n\n| Artifact Name                       | Includes Flexmark | Use Case                         |\n|------------------------------------|-------------------|-----------------------------------|\n| `javafx-markdown-preview`         | ❌ No              | For Maven users with their own Flexmark setup    |\n| `javafx-markdown-preview-all`     | ✅ Yes            | Works out of the box, no extra setup       |\n\n---\n\n## ✨ Features\n\n- 📂 Load `.md` file or raw Markdown string\n- 🔄 Real-time preview with file change detection\n- 🖥️ Opens in a separate JavaFX window\n- 🔁 Reopen preview window if closed\n- 🧩 Embed in any JavaFX scene or layout\n- ☕ Supports both Java and JavaFX projects\n- ⚡ Lightweight and reusable as a utility\n\n---\n\n## 📦 Install via Maven\n\n### 🛠️ Option 1: All-in-One (Flexmark + Code)\n\nAdd the dependency in your `pom.xml`:\n\n```xml\n\u003cdependency\u003e\n\n  \u003cgroupId\u003eio.github.raghul-tech\u003c/groupId\u003e\n  \n  \u003cartifactId\u003ejavafx-markdown-preview-all\u003c/artifactId\u003e\n  \n  \u003cversion\u003e1.0.3\u003c/version\u003e\n  \n\u003c/dependency\u003e\n```\nOr browse it on [Maven Central](https://central.sonatype.com/artifact/io.github.raghul-tech/javafx-markdown-preview-all).\n\n### 🪶 Option 2: Minimal (bring your own Flexmark)\n\n```xml\n\u003cdependency\u003e\n  \u003cgroupId\u003eio.github.raghul-tech\u003c/groupId\u003e\n  \u003cartifactId\u003ejavafx-markdown-preview\u003c/artifactId\u003e\n  \u003cversion\u003e1.0.3\u003c/version\u003e\n\u003c/dependency\u003e\n\n\u003cdependency\u003e\n  \u003cgroupId\u003ecom.vladsch.flexmark\u003c/groupId\u003e\n  \u003cartifactId\u003eflexmark-all\u003c/artifactId\u003e\n  \u003cversion\u003e0.64.8\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\nOr browse it on [Maven Central](https://central.sonatype.com/artifact/io.github.raghul-tech/javafx-markdown-preview).\n\n---\n\n## 🏗️ Example Projects\n- You’ll find ready-to-run examples in the [`examples/`](examples/) directory:\n\n\t- [`ExampleWindow.java`](examples/ExampleWindow.java) – Launches the preview in a **standalone JavaFX window**, ideal for external Markdown viewers or editor popouts.\n\n\t- [`ExampleTabPane.java`](examples/ExampleTabPane.java) – Embeds the preview as a tab inside a `TabPane`, great for multi-tab document editors.\n\n\t- [`ExampleWebview.java`](examples/ExampleWebview.java) –  Shows how to **embed the preview WebView** into any JavaFX layout, such as `VBox`, `BorderPane`, or `StackPane`.\n\t\n\t- [`ExampleRenderer.java`](examples/ExampleRenderer.java) –  Demonstrates using the `MarkdownRenderer` utility to **convert Markdown content into styled HTML**, useful for exporting or rendering elsewhere. \n\n✅ To run an example:\n\n1. Download or clone this repository.\n\n2. Navigate to [`examples/`](examples/) folder.\n\n3. Compile and run the desired file.\n\n\u003e ✅ Tip: Each example is standalone—feel free to adapt and copy the patterns directly into your project.\n\n---\n\n## 💡 Run Using JAR\n### **Compile:**\n\n```bash\njavac -cp java-markdown-preview-all-1.0.3.jar Markdown.java\n```\n### **Run:**\n\n\u003e Windows:\n```bash\njava -cp .;java-markdown-preview-all-1.0.3.jar Markdown\n```\n\n\u003e Linux/macOS:\n```bash\njava -cp .:java-markdown-preview-all-1.0.3.jar Markdown\n```\n---\n\n\n\n## 🔍 Documentation\n\n- 📚 [Javadoc](https://javadoc.io/doc/io.github.raghul-tech/javafx-markdown-preview)\n\n- 📝 [Changelog](CHANGELOG.md)\n\n- ❓ [Issue Tracker](https://github.com/raghul-tech/javafx-Markdown-Preview/issues)\n\n---\n\n\n## 🧩 Requirements\n- OpenJFX libraries if using Java 11+\n\n- JavaFX (use OpenJFX for Java 11+)\n\n- Maven for dependency management\n\n---\n\n## 🆕 Changelog:\n\n* View all releases on the [Releases Page.](https://github.com/raghul-tech/JavaFX-Markdown-Preview/releases)\n* For a detailed log of all changes, refer to the [CHANGELOG.md](CHANGELOG.md) file.\n\n---\n\n## 🤝 Contributing\n* We welcome contributions of all kinds:\n\n   * 🛠️ Bug fixes\n\n   * 🌟 Feature suggestions\n\n   * 📚 Documentation improvements\n\n   * 🧪 More usage examples\n\n\u003e Please check the [Contributing Guide](CONTRIBUTING.md) before starting.\n\n---\n\n## 🐞 Report a Bug\n   * If you've encountered a bug, please report it by clicking the link below. \n   \tThis will guide you through the bug-reporting process:\n   \t➡️ [Click here to report a bug](https://github.com/raghul-tech/JavaFX-Markdown-Preview/issues/new?template=bug_report.yaml)\n \n---\n\n## 📄 License\n- This project is licensed under the [GNU General Public License v3 (GPL-3.0)](LICENSE).\n\n---\n\n## 📬 Contact\nEmail: [raghultech.app@gmail.com](mailto:raghultech.app@gmail.com)\n\n---\n\n## ☕ Support\n\u003e If you find this project useful, consider buying me a coffee!\n\n\u003ca href=\"https://buymeacoffee.com/raghultech\"\u003e \u003cimg src=\"https://img.shields.io/badge/Buy%20Me%20A%20Coffee-Support-orange.svg?style=flat-square\" alt=\"Buy Me A Coffee\" /\u003e \u003c/a\u003e \n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fraghul-tech%2Fjavafx-markdown-preview","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fraghul-tech%2Fjavafx-markdown-preview","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fraghul-tech%2Fjavafx-markdown-preview/lists"}