Skip to content

Latest commit

 

History

History
110 lines (69 loc) · 4.45 KB

README.md

File metadata and controls

110 lines (69 loc) · 4.45 KB
Raw

Published on Vaadin Directory Stars on vaadin.com/directory Build Status Maven Central Javadoc

Markdown Editor Add-on

This is a wrapper around the React Markdown Editor component.

Features

  • Supports both visual editing of markdown and also just viewing markdown content
  • Support for dark and light themes
  • Built in support for sanitization

Online demo

Online demo here

Download release

Available in Vaadin Directory

Maven install

Add the following dependencies in your pom.xml file:

<dependency>
   <groupId>com.flowingcode.vaadin.addons</groupId>
   <artifactId>markdown-editor-addon</artifactId>
   <version>X.Y.Z</version>
</dependency>

Release versions are available from Maven Central repository. For SNAPSHOT versions see here.

Building and running demo

  • git clone repository
  • mvn clean install jetty:run

To see the demo, navigate to http://localhost:8080/

Release notes

See here

Issue tracking

The issues for this add-on are tracked on its github.com page. All bug reports and feature requests are appreciated.

Contributions

Contributions are welcome, but there are no guarantees that they are accepted as such.

As first step, please refer to our Development Conventions page to find information about Conventional Commits & Code Style requirements.

Then, follow these steps for creating a contribution:

  • Fork this project.
  • Create an issue to this project about the contribution (bug or feature) if there is no such issue about it already. Try to keep the scope minimal.
  • Develop and test the fix or functionality carefully. Only include minimum amount of code needed to fix the issue.
  • For commit message, use Conventional Commits to describe your change.
  • Send a pull request for the original project.
  • Comment on the original issue that you have implemented a fix for it.

License & Author

This add-on is distributed under Apache License 2.0. For license terms, see LICENSE.txt.

Markdown Editor Add-on is written by Flowing Code S.A.

Developer Guide

Getting started

Markdown Viewer

To use the viewer, instantiate it and add it to a view like this:

MarkdownViewer mdv = new MarkdownViewer();
mdv.setSizeFull();
mdv.setDataColorMode(DataColorMode.LIGTH);
mdv.setContent("# h1 Heading");
add(mdv);

Markdown Editor

To use the editor, similar to the viewer, instantiate it and add it to a view like this:

MarkdownEditor mde = new MarkdownEditor();
mde.setSizeFull();
mde.setPlaceholder("Enter Markdown here");
mde.setMaxLength(500);
mde.setDataColorMode(DataColorMode.LIGTH);

To obtain the edited value, call getContent()

Special configuration when using Spring

By default, Vaadin Flow only includes com/vaadin/flow/component to be always scanned for UI components and views. For this reason, the add-on might need to be allowed in order to display correctly.

To do so, just add com.flowingcode to the vaadin.allowed-packages property in src/main/resources/application.properties, like:

vaadin.allowed-packages = com.vaadin,org.vaadin,dev.hilla,com.flowingcode

More information on Spring scanning configuration here.