README.md

Markdown Writer FX

An open source Markdown editor written in JavaFX.

For Markdown rendering it uses commonmark-java or flexmark-java, two Java implementations of the CommonMark specification.

Features

• Syntax highlighting in editor
• Keyboard shortcuts to insert Markdown (Bold, Italic, Code, Links, Images, Header, Lists, ...)
• Auto-indent lists
• Search and replace
• Spell and grammar checking with LanguageTool for more than 30 languages and dialects.
• Project manager
• HTML preview
• HTML source preview
• Markdown AST view
• Multi-platform: Windows, Mac and Linux

Download

See "Assets" in releases section.

Changes

See Change Log

Building

Gradle can be used to build Markdown Writer FX from source code. Java 19 is required to run Gradle (and Markdown Writer FX).

The Gradle task assembleDist builds a distribution for the current platform (uses jpackage) and requires that Gradle is running on a JDK that includes JavaFX. E.g. BellSoft Liberica JDK (package 'Full JDK') or Azul Zulu JDK (package 'JDK FX').

Credits

• Tomas Mikula for RichTextFX, ReactFX, WellBehavedFX, Flowless and UndoFX
• Mikael Grev for MigLayout and Tom Eugelink for MigPane
• Vladimir Schneider for flexmark-java Markdown parser
• Atlassian for commonmark-java Markdown parser
• Jens Deters for FontAwesomeFX
• The ControlsFX project
• Matthieu Brouillard for CSSFX
• Lea Verou, Golmote & more for Prism

License

Markdown Writer FX is open source licensed under the BSD 2-Clause License