{"id":15048564,"url":"https://github.com/jpro-one/markdown-javafx-renderer","last_synced_at":"2025-10-04T10:30:45.516Z","repository":{"id":48895184,"uuid":"141436551","full_name":"JPro-one/markdown-javafx-renderer","owner":"JPro-one","description":"Markdown for JavaFX","archived":true,"fork":false,"pushed_at":"2023-09-25T09:18:21.000Z","size":140,"stargazers_count":51,"open_issues_count":12,"forks_count":7,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-09-30T00:43:35.225Z","etag":null,"topics":["java","javafx","jpro","markdown","md"],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/JPro-one.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-07-18T13:11:11.000Z","updated_at":"2024-06-18T15:02:21.000Z","dependencies_parsed_at":"2023-01-19T23:18:17.477Z","dependency_job_id":null,"html_url":"https://github.com/JPro-one/markdown-javafx-renderer","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JPro-one%2Fmarkdown-javafx-renderer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JPro-one%2Fmarkdown-javafx-renderer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JPro-one%2Fmarkdown-javafx-renderer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JPro-one%2Fmarkdown-javafx-renderer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/JPro-one","download_url":"https://codeload.github.com/JPro-one/markdown-javafx-renderer/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":235238023,"owners_count":18958035,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["java","javafx","jpro","markdown","md"],"created_at":"2024-09-24T21:14:03.815Z","updated_at":"2025-10-04T10:30:45.040Z","avatar_url":"https://github.com/JPro-one.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# [MDFX](https://github.com/JPro-one/jpro-routing) has moved to [JPro Platform](https://github.com/JPro-one/jpro-platform)!\n\n🚨 **IMPORTANT NOTICE:** This repository has been relocated. All the content, issues, and activity have been transferred to our new repository.\n\n## Why did we move?\nWe've decided to consolidate our repositories into a single one to better manage and streamline our projects.\nThis will allow us to better prioritize and address issues and pull requests, as well as to release new versions faster.\n___\n\n[![JPro supported](https://img.shields.io/badge/JPro-supported-brightgreen.svg)](https://www.jpro.one/) \n[![JFX-Central](https://img.shields.io/badge/jfxcentral-mdfx-brightgreen.svg)](https://www.jfx-central.com/libraries/mdfx) \n[![Build Status](https://travis-ci.org/JPro-one/markdown-javafx-renderer.svg?branch=master)](https://travis-ci.org/JPro-one/markdown-javafx-renderer)\n\nMDFX is a simple markdown-renderer for JavaFX.\nIt's based on [flexmark-java](https://github.com/vsch/flexmark-java).\nIt is used to render the [documentation for jpro](https://www.jpro.one/?page=docs/current/1.1/) at [jpro.one](https://www.jpro.one/).\n\n\n## Usage\n\n\n### Add the library to your project:\nFor Gradle, add the following to your `build.gradle`:\n\nAdd the following repository:\n```\nrepositories {\n    maven {\n        url \"https://sandec.jfrog.io/artifactory/repo\"\n    }\n}\n```\nAdd The following dependency:\n```\ndependencies {\n    compile \"com.sandec:mdfx:0.2.12\"\n}\n```\n\nUsage:\n```\nimport com.sandec.mdfx.MarkdownView;\n\nMarkdownView mdfx = new MarkdownView(\"your-markdown\");\n```\n\nSimple Application:\n[Source Code](https://github.com/jpro-one/markdown-javafx-renderer/blob/master/example/src/main/java/com/sandec/mdfx/ExampleMDFX.java)\n\nFeature Overview:\n[Reference-Markdown-File](https://github.com/jpro-one/markdown-javafx-renderer/blob/master/example/src/main/resources/com/sandec/mdfx/sample.md)\n\n\nYou can personalize the looking of your markdown via css.\n[Minimal default-file](https://github.com/jpro-one/markdown-javafx-renderer/blob/master/src/main/resources/com/sandec/mdfx/mdfx-default.css)\nTo use your own css, you have to overwrite the `getDefaultStylehsheets`.\n```java\nprotected List\u003cString\u003e getDefaultStylehsheets() {\n    return List.of(\"/your-css.css\");\n}\n```\nAlternatively, you can also return an empty list, and add your css via the `getStylesheets` of the Scene.\n\n\n## Changelog\n\n### 0.2.12 (28. March 2023)\n* It's no longer necessary to add the default-css. You can add your own css via `getDefaultStylehsheets`.\n### 0.2.11\n* Fixed wrong layouting of the Image.\n### 0.2.10\n* Added a new default implementation for Images.\nThe images no longer expand outside of the viewport.\n* The images are now also loaded asynchronously.\n### 0.2.9\n* Fixed an issue, which caused that sometimes a whitespace was missing in links.\n### 0.2.8 (13. October 2022)\n* Changed JavaFX Dependencie to be compile only.\n### 0.2.7 (10. March 2022)\n* Updated Flexmark to 0.64\n### 0.2.6 (10. March 2022)\n* Fixed Newline character in links.\n### 0.2.5 (11. November 2021)\n* Fixed an bug with nested Sorted/Unsorted lists.\n### 0.2.4\n* Fixed an layouting issue with lists. In some situations \"...\" was shown for left label counting the entries.\n### 0.2.3\n* The blockquote is now configured with the css variables `-mdfx-bq-color-border` and `-mdfx-bq-color-border`. Users might want to add these variables to their css. \n* Ordered lists start now with 1 instead of 0.\n### 0.2.2\n* -- skip this version --\n### 0.2.1\n* Added support for BlockQuotes\n* Added support for TaskLists\n* Renamed MDFXNode to MarkdownView\n* Moved internal classes to an impl package\n### 0.2.0\n* Added support for ordered lists.\n* We now us the Java11 Module System. At least Java11 is now required.\n### 0.1.9\n* Added support for strikethrough\n* It's now possible to change the link color in the css with `-mdfx-link-color`\n* Updated flexmark to 0.62.2\n### 0.1.8\n* The property mdString of MDFXNode is now public\n\n## Development\nRun the sample:\n```\n./gradlew example:run\n./gradlew example:jproRun\n```\n\nDeploy new release:\n```\n./gradlew :publish\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjpro-one%2Fmarkdown-javafx-renderer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjpro-one%2Fmarkdown-javafx-renderer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjpro-one%2Fmarkdown-javafx-renderer/lists"}