Markdown editor control for JavaFX

Daniel Gyoerffy

Last update: Dec 28, 2022

Related tags

Overview

MarkdownEditorControlFX

An advanced markdown-editor control for JavaFX.

Features

Three view modes : EDITOR_ONLY, PREVIEW_ONLY, BOTH
Formatting toolbar items: bold, italic, strikethrough, monospaced
Live preview
Styleable through JavaFX CSS
...and more

TODO

Syntax highlighting in the editor-area
Internationalization support
Find dialog

Contributions are welcome!

Requirements

Java 11 or higher

Download

Maven example

<repositories>
		<repository>
		    <id>jitpack.ioid>
		    <url>https://jitpack.iourl>
		repository>
repositories>

<dependency>
	    <groupId>com.github.DansoftownergroupId>
	    <artifactId>MarkdownEditorControlFXartifactId>
	    <version>0.6.3version>
dependency>

Gradle example

repositories {
	...
    // For MarkdownEditorControl
    maven { url 'https://jitpack.io' }
    
    // For some of it's dependencies
    maven { url "http://sandec.bintray.com/repo"}
    maven { url "https://dl.bintray.com/jerady/maven" }
}

dependencies {
	implementation 'com.github.Dansoftowner:MarkdownEditorControlFX:0.6.3'
}

View modes

As mentioned, the control supports multiple view modes.
Each view mode is represented by the enum: com.dansoftware.mdeditor.MarkdownEditorControl.ViewMode.
It can be set using the MarkdownEditorControl#setViewMode method.

1. Editor only (`ViewMode.EDITOR_ONLY`)

In this mode, only the editor-area is visible.

2. Preview only (`ViewMode.PREVIEW_ONLY`)

In this mode, only the preview-area is visible.

3. Editor and preview (`ViewMode.BOTH`)

Basic usage

MarkdownEditorControl control = new MarkdownEditorControl();
control.setToolbarVisible(true); // setting the toolbar visible on the top
control.setMarkdown("# Default "); // setting an initial text

// ...add it to your container or whatever
container.getChildren().add(control);

Demos

LightDemo - Light-style example
DarkDemo - Dark-style example

Used libraries

markdown-javafx-renderer - JavaFX markdown renderer based on flexmark
RichTextFX - Rich-text area for JavaFX
FontAwesomeFX - for the icons

Used libraries for the demos:

JMetro

Feedback

If you use this library in your project, let me know in the discussions!

License

Apache 2.0

A library of +70 ready-to-use animations for JavaFX

AnimateFX A library of ready-to-use animations for JavaFX Features: Custom animations Custom interpolators Play/Stop animation Play an animation after

Jan 5, 2023

BootstrapFX: Bootstrap for JavaFX

BootstrapFX BootstrapFX is a partial port of Twitter Bootstrap for JavaFX. It mainly provides a CSS stylesheet that closely resembles the original whi

Dec 28, 2022

A Java framework for creating sophisticated calendar views (JavaFX 8, 9, 10, and 11)

CalendarFX A Java framework for creating sophisticated calendar views based on JavaFX. A detailed developer manual can be found online: CalendarFX 8 D

Jan 6, 2023

Allow runtime modification of JavaFX CSS

cssfx ⚠ WARNING ⚠ In version 11.3.0 we have relocated & refactored the project. maven groupId has been changed to fr.brouillard.oss java module name h

Jan 2, 2023

A JavaFX UI framework to create fully customized undecorated windows

CustomStage A JavaFX undecorated stage which can fully be customized Donations If this project is helpful to you and love my work and feel like showin

Jan 6, 2023

MDI components for JavaFX

DesktopPaneFX DesktopPaneFX is a JavaFX version of Swing’s JDesktopPane which can be used as a container for individual "child" similar to JInternalFr

Sep 23, 2022

Efficient VirtualFlow for JavaFX

Flowless Efficient VirtualFlow for JavaFX. VirtualFlow is a layout container that lays out cells in a vertical or horizontal flow. The main feature of

Nov 24, 2022

A framework for easily creating forms for a JavaFX UI.

FormsFX Forms for business application made easy. Creating forms in Java has never been this easy! Maven To use this framework as part of your Maven b

Dec 30, 2022

:icecream: iOS frosty/translucent effect to JavaFX

FroXty is JavaFX library which replicates the famous iOS translucent effect with ease. Set-up FroXty can be imported into your project either by downl

Dec 11, 2022