{"id":15719606,"url":"https://github.com/dansoftowner/markdowneditorcontrolfx","last_synced_at":"2025-05-08T07:37:56.286Z","repository":{"id":130614812,"uuid":"355663233","full_name":"Dansoftowner/MarkdownEditorControlFX","owner":"Dansoftowner","description":"Markdown editor control for JavaFX","archived":false,"fork":false,"pushed_at":"2021-10-14T08:19:36.000Z","size":1532,"stargazers_count":27,"open_issues_count":11,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-31T17:25:21.319Z","etag":null,"topics":["desktop","gui","java","javafx","markdown"],"latest_commit_sha":null,"homepage":"","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/Dansoftowner.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-04-07T19:41:14.000Z","updated_at":"2024-06-28T09:27:05.000Z","dependencies_parsed_at":"2023-03-23T12:17:03.031Z","dependency_job_id":null,"html_url":"https://github.com/Dansoftowner/MarkdownEditorControlFX","commit_stats":null,"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dansoftowner%2FMarkdownEditorControlFX","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dansoftowner%2FMarkdownEditorControlFX/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dansoftowner%2FMarkdownEditorControlFX/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dansoftowner%2FMarkdownEditorControlFX/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Dansoftowner","download_url":"https://codeload.github.com/Dansoftowner/MarkdownEditorControlFX/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253024528,"owners_count":21842398,"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":["desktop","gui","java","javafx","markdown"],"created_at":"2024-10-03T21:56:19.750Z","updated_at":"2025-05-08T07:37:56.246Z","avatar_url":"https://github.com/Dansoftowner.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MarkdownEditorControlFX\n\n![GitHub release (latest by date)](https://img.shields.io/github/v/release/Dansoftowner/MarkdownEditorControlFX)\n[![](https://jitpack.io/v/Dansoftowner/MarkdownEditorControlFX.svg)](https://jitpack.io/#Dansoftowner/MarkdownEditorControlFX)\n![GitHub issues](https://img.shields.io/github/issues/Dansoftowner/MarkdownEditorControlFX)\n![GitHub last commit](https://img.shields.io/github/last-commit/DansoftOwner/MarkdownEditorControlFX)\n![GitHub](https://img.shields.io/github/license/Dansoftowner/MarkdownEditorControlFX)\n\n**An advanced markdown-editor control for JavaFX.**\n\n![Demo gif](screenshots/demo-dark.gif)\n\n# Features\n\n* Three **view modes** : `EDITOR_ONLY`, `PREVIEW_ONLY`, `BOTH`\n* Formatting toolbar items: `bold`, `italic`, `strikethrough`, `monospaced`\n* Live preview\n* Styleable through `JavaFX CSS`\n* ...and more\n\n### TODO\n* Syntax highlighting in the `editor-area`\n* Internationalization support\n* Find dialog\n\nContributions are welcome!\n\n# Requirements\nJava 11 or higher\n\n# Projects using MarkdownEditorControlFX\n\nIf you use this library in your project, let me know in the [discussions](https://github.com/Dansoftowner/MarkdownEditorControlFX/discussions)!\n\n* [Boomega](https://github.com/Dansoftowner/Boomega) - A modern book explorer \u0026 catalog application\n\n# Download\n\n#### Maven example\n\n```xml\n\u003crepositories\u003e\n\t\t\u003crepository\u003e\n\t\t    \u003cid\u003ejitpack.io\u003c/id\u003e\n\t\t    \u003curl\u003ehttps://jitpack.io\u003c/url\u003e\n\t\t\u003c/repository\u003e\n\u003c/repositories\u003e\n```\n\n```xml\n\u003cdependency\u003e\n\t    \u003cgroupId\u003ecom.github.Dansoftowner\u003c/groupId\u003e\n\t    \u003cartifactId\u003eMarkdownEditorControlFX\u003c/artifactId\u003e\n\t    \u003cversion\u003e0.6.3\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n#### Gradle example\n```groovy\nrepositories {\n\t...\n    // For MarkdownEditorControl\n    maven { url 'https://jitpack.io' }\n    \n    // For some of it's dependencies\n    maven { url \"http://sandec.bintray.com/repo\"}\n    maven { url \"https://dl.bintray.com/jerady/maven\" }\n}\n```\n\n```groovy\ndependencies {\n\timplementation 'com.github.Dansoftowner:MarkdownEditorControlFX:0.6.3'\n}\n```\n\n# View modes\n\nAs mentioned, the control supports multiple view modes.  \nEach view mode is represented by the enum: `com.dansoftware.mdeditor.MarkdownEditorControl.ViewMode`.  \nIt can be set using the `MarkdownEditorControl#setViewMode` method.\n\n### 1. Editor only (`ViewMode.EDITOR_ONLY`)\nIn this mode, only the editor-area is visible.\n\n![Screenshot](screenshots/EditorOnly.jpg)\n\n\n### 2. Preview only (`ViewMode.PREVIEW_ONLY`)\nIn this mode, only the preview-area is visible.\n\n![Screenshot](screenshots/PreviewOnly.jpg)\n\n### 3. Editor and preview (`ViewMode.BOTH`)\n\n![Screenshot](screenshots/EditorAndPreview.jpg)\n\n# Basic usage\n\n```java\nMarkdownEditorControl control = new MarkdownEditorControl();\ncontrol.setToolbarVisible(true); // setting the toolbar visible on the top\ncontrol.setMarkdown(\"# Default \"); // setting an initial text\n\n// ...add it to your container or whatever\ncontainer.getChildren().add(control);\n```\n\n# Demos\n\n* [LightDemo](src/test/java/com/dansoftware/mdeditor/test/LightDemo.java) - Light-style example\n* [DarkDemo](src/test/java/com/dansoftware/mdeditor/test/DarkDemo.java) - Dark-style example\n\n# Used libraries\n\n* [markdown-javafx-renderer](https://github.com/JPro-one/markdown-javafx-renderer) - JavaFX markdown renderer based on [flexmark](https://github.com/vsch/flexmark-java)\n* [RichTextFX](https://github.com/FXMisc/RichTextFX) - Rich-text area for JavaFX\n* [FontAwesomeFX](https://bitbucket.org/Jerady/fontawesomefx/src/master/) - for the icons\n\nUsed libraries for the demos:\n* [JMetro](https://www.pixelduke.com/java-javafx-theme-jmetro/)\n\n# License\n**Apache 2.0**\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdansoftowner%2Fmarkdowneditorcontrolfx","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdansoftowner%2Fmarkdowneditorcontrolfx","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdansoftowner%2Fmarkdowneditorcontrolfx/lists"}