hub / github.com/JFormDesigner/markdown-writer-fx

github.com/JFormDesigner/markdown-writer-fx @1.0

Chat with this repo

repository ↗ · DeepWiki ↗ · release 1.0 ↗ · + Follow

997 symbols 2,998 edges 239 files 115 documented · 12%

What it actually does AI analysis from the code graph — generated when you open this

loading…

README

Markdown Writer FX

An open source Markdown editor written in JavaFX.

Markdown Writer FX Screenshot

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

Extension points exported contracts — how you extend this code

PreviewViewAddon (Interface)

@author Karl Tauber [5 implementers]

src/main/java/org/markdownwriterfx/addons/PreviewViewAddon.java

MarkdownSyntaxHighlighterAddon (Interface)

@author Karl Tauber

src/main/java/org/markdownwriterfx/addons/MarkdownSyntaxHighlighterAddon.java

Highlighter (Interface)

(no doc) [2 implementers]

src/main/java/org/markdownwriterfx/addons/MarkdownSyntaxHighlighterAddon.java

PreviewRendererAddon (Interface)

@author Karl Tauber

src/main/java/org/markdownwriterfx/addons/PreviewRendererAddon.java

SpellCheckerAddon (Interface)

@author Karl Tauber

src/main/java/org/markdownwriterfx/addons/SpellCheckerAddon.java

Core symbols most depended-on inside this repo

get

called by 207

src/main/java/org/markdownwriterfx/Messages.java

get

called by 128

src/main/java/org/markdownwriterfx/projects/ProjectSettings.java

length

called by 108

src/main/java/org/markdownwriterfx/editor/EmbeddedImageOps.java

addListener

called by 87

src/main/java/org/markdownwriterfx/editor/FindReplacePane.java

set

called by 70

src/main/java/org/markdownwriterfx/options/Options.java

addStyledRange

called by 59

src/main/java/org/markdownwriterfx/editor/MarkdownSyntaxHighlighter.java

toString

called by 50

src/main/java/org/markdownwriterfx/util/Item.java

equals

called by 41

src/main/java/org/markdownwriterfx/util/Item.java

Shape

Method 879

Class 95

Interface 12

Function 8

Enum 3

Languages

Java99%

TypeScript1%

Kotlin1%

Modules by API surface

src/main/java/org/markdownwriterfx/options/Options.java82 symbols

src/main/java/org/markdownwriterfx/editor/SmartEdit.java70 symbols

src/main/java/org/markdownwriterfx/editor/MarkdownEditorPane.java59 symbols

src/main/java/org/markdownwriterfx/preview/MarkdownPreviewPane.java36 symbols

src/main/java/org/markdownwriterfx/FileEditorTabPane.java33 symbols

src/main/java/org/markdownwriterfx/spellchecker/SpellChecker.java31 symbols

src/main/java/org/markdownwriterfx/editor/FindReplacePane.java29 symbols

src/test/java/org/markdownwriterfx/editor/TestStyleRanges.java27 symbols

src/main/java/org/markdownwriterfx/editor/ParagraphOverlayGraphicFactory.java25 symbols

src/main/java/org/markdownwriterfx/FileEditor.java25 symbols

src/main/java/org/markdownwriterfx/util/Utils.java23 symbols

src/main/java/org/markdownwriterfx/editor/MarkdownSyntaxHighlighter.java22 symbols

For agents

$ claude mcp add markdown-writer-fx \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact