Wysiwyg MD Editor plugin for Kanboard

Integrates external MD editors into Kanboard in order to conveniently edit and preview the markdown textareas, as well as render the markdown fields in the Kanboard interface. Each editor may allow for different customizations of functionality, MD features, and UI themes. Rendering can parametrize theme, code highlight, and background transparency.

✅ If you want a new language pack added or an existing one corrected, please, post a PR !

✅ If you like and use the plugin, please, give a ⭐ to this repository !

[↓ Bottom] [↑ Top]

⚠️ News

Unfortunately, stackedit.net the English version of the StackEdit+ online app, was eventually taken down and for good. Adopting this editor to embed in KB was an optimal choice I made amongst multiple editors, as it combined functionality flexibility and UI tweaks. So when it was gone I was seriously puzzled how to replace it. Actually, there are only 2 similar editors available, both with their respective pros and cons.

Well, tough call 😏 I couldn't decide between them, so went for integrating both 😁
And left the choice to you, to consider which one fits you better.
See why in the section just below.

✨ `Bad` news and `Good` news as of v.0.9.2 ! ✨

❌ stackedit.net is gone, sad 🙁
✔️ yet there are stackedit.io and stackedit.cn to replace it
❌ stackedit.io has basic features only
✔️ but stackedit.io is in English
❌ stackedit.net is in Chinese
✔️ but stackedit.net has extra features and themes

Overall:

✅ stackedit.io is simple and minimalistic yet fully functional, and does the work just great if you don't need extras and a fixed light theme is fine !
✅ the Chinese texts of stackedit.net don't get too much in the way, as the UI has intuitive buttons and shortcuts, while being much more pleasant and caring on the eyes !

So, you really need to try each of the editors for yourself !

[↓ Bottom] [↑ Top]

Features

✨ Explicit internal Emoji Font is available as of v.0.9.6 ! ✨

✨ Font Awesome Icons Picker is available as of v.0.9.4 ! ✨

✨ Emoji Picker is available as of v.0.9.3 ! ✨

✨ Rendering options are available as of v.0.9.0 ! ✨

Currently integrates the EasyMDE, StackEdit and StackEdit+ markdown editors.
All editors are configured to be GFM compatible.
Side preview is available, themes and various convenience options.
Configurable buttons for editors to inject into the KB editing toolbar of markdown textareas.
✨ Option for custom rendering of markdown fields (using EasyMDE locally with JavaScript).
✨ Rendering can be parametrized with theme, code highlight, and background transparency.
✨ Configurable Emoji Picker button for editing toolbar of markdown textareas (also integrated into EasyMDE).
✨ Configurable Font Awesome Icons Picker button for editing toolbar of markdown textareas (also integrated into EasyMDE). Compatible with Font Awesome 4.7.0, since this is what Kanboard comes with.

For a better preview and feel of the actual editors visit:

EasyMDE Live Demo
StackEdit Online App (English)
StackEdit+ Online App (Chinese)

[↓ Bottom] [↑ Top]

Screenshots

Configurable buttons of MD editors injected into the textarea editing toolbar.

![textarea editing toolbar injected buttons](Assets/config/textarea-editing-toolbar-injected-buttons.png "textarea editing toolbar with injected MD editors buttons")

Preview of Emoji Picker.

![preview easymde](Screenshots/preview-picker-emoji.png "preview emoji picker")

Preview of Font Awesome Icons Picker.

![preview easymde](Screenshots/preview-picker-faicons.png "preview faicons picker")

EasyMDE with side preview using the dimmed theme.

![preview easymde](Screenshots/preview-editor-easymde.png "preview easymde")

StackEdit+ with side preview using the default dark theme.

![preview stackedit plus](Screenshots/preview-editor-stackedit-plus.png "preview stackedit plus")

Example of task description tooltip rendered with EasyMDE.

![preview tooltip render](Screenshots/preview-render-tootip.png "preview tooltip render")

[↓ Bottom] [↑ Top]

Configure

Go to Settings ⥂ Wysiwyg MD Editor.

Setup Symbol Picker Options

Follow the explanations to configure and preview the symbol picker(s) of your preference. ![setup symbol picker options](Screenshots/setup-options-symbol-picker.png "setup symbol picker options")

Setup Editing Options

Follow the explanations to configure and preview the MD editor(s) of your preference. ![setup editing options](Screenshots/setup-options-editing.png "setup editing options")

Setup Rendering Options

This section allows you to enable and parametrize custom rendering of markdown fields that will override the original KB display. ![setup rendering options](Screenshots/setup-options-rendering.png "setup rendering options")

[↓ Bottom] [↑ Top]

Installation & Compatibility

Installation

- Install via the **Kanboard Plugin Directory** or see [INSTALL.md](INSTALL.md) - Read the full [**Changelog**](changelog.md "See changes") to see the latest updates

Compatibility

- Requires [Kanboard](https://github.com/kanboard/kanboard "Kanboard - Kanban Project Management Software") ≥`1.2.33` - **Other Plugins & Action Plugins** - Can utilize the `HighlightCodeSyntax` plugin (if installed) for rendering purposes. - May conflict with or override the functionality of the `MarkdownPlus` plugin when the rendering option is turned on. - **Core Files & Templates** - `0` Template override - _No database changes_

Translations

- Available translations for some common languages `DE`, `ES`, `FR`, `IT`, `PT`, `RU` - yet, they are _mechanically translated using Google Translate_ ! - _Translation for `en_US` is the default_ if there is no translation pack for the user selected language in KB. - The actual UI language of the editors is fixed (either **English** or **Chinese**), and **`no translations`** are available for them.

[↓ Bottom] [↑ Top]