https://github.com/jformdesigner/markdown-writer-fx

Markdown Writer FX
https://github.com/jformdesigner/markdown-writer-fx

commonmark markdown richtextfx

Last synced: 8 days ago
JSON representation

Markdown Writer FX

• Host: GitHub
• URL: https://github.com/jformdesigner/markdown-writer-fx
• Owner: JFormDesigner
• License: bsd-2-clause
• Created: 2015-08-24T12:22:59.000Z (about 9 years ago)
• Default Branch: main
• Last Pushed: 2024-01-18T11:31:52.000Z (10 months ago)
• Last Synced: 2024-09-24T00:21:46.508Z (about 2 months ago)
• Topics: commonmark, markdown, richtextfx
• Language: Java
• Size: 4.49 MB
• Stars: 430
• Watchers: 27
• Forks: 80
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![Markdown Writer FX](images/markdown-writer-fx-64.png)

Markdown Writer FX

==================

An open source [Markdown] editor written in JavaFX.

![Markdown Writer FX Screenshot](images/screenshot.png)

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](https://languagetool.org/)

    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](https://github.com/JFormDesigner/markdown-writer-fx/releases).

Changes

-------

See [Change Log](CHANGES.md)

Building

--------

[Gradle](https://gradle.org) 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](LICENSE)

   [Markdown]: http://daringfireball.net/projects/markdown/

   [CommonMark]: http://commonmark.org/

   [commonmark-java]: https://github.com/atlassian/commonmark-java

   [flexmark-java]: https://github.com/vsch/flexmark-java

   [Markdown Extra]: https://michelf.ca/projects/php-markdown/extra/

   [MultiMarkdown]: http://fletcherpenney.net/multimarkdown/

   [Github-flavoured-Markdown]: https://help.github.com/articles/github-flavored-markdown/

   [MigLayout]: https://github.com/mikaelgrev/miglayout

   [RichTextFX]: https://github.com/TomasMikula/RichTextFX

   [ReactFX]: https://github.com/TomasMikula/ReactFX

   [WellBehavedFX]: https://github.com/TomasMikula/WellBehavedFX

   [Flowless]: https://github.com/TomasMikula/Flowless

   [UndoFX]: https://github.com/TomasMikula/UndoFX

   [FontAwesomeFX]: https://bitbucket.org/Jerady/fontawesomefx

   [ControlsFX]: http://fxexperience.com/controlsfx/

   [CSSFX]: https://github.com/McFoggy/cssfx

   [Prism]: https://github.com/PrismJS/prism