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]

Features

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

• Currently integrates the EasyMDE and StackEdit+ markdown editors
• Both editors are configured to be GFM compatible
• Side preview is available, themes and various convenience options
• Configurable buttons 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. ✨

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

• EasyMDE Live Demo
• StackEdit+ Online App

[↓ Bottom] [↑ Top]

Screenshots

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

EasyMDE with side preview using the dimmed theme.

StackEdit+ with side preview using the default dark theme.

Example of task description tooltip rendered with EasyMDE.

[↓ Bottom] [↑ Top]

Usage

Go to Settings ⥂ Wysiwyg MD Editor

Follow the explanations in Setup Editing Options to configure and preview the MD editor(s) of your preference.

The section Setup Rendering Options allows you to enable and parametrize custom rendering of markdown fields that will override the original KB display.

[↓ Bottom] [↑ Top]

Installation & Compatibility

Installation

• Install via the Kanboard Plugin Directory or see INSTALL.md
• Read the full Changelog to see the latest updates

Compatibility

• Requires Kanboard ≥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.

[↓ Bottom] [↑ Top]

Authors & Contributors

• Im[F(x)] - Author
• Contributors welcome for translations !

[↓ Bottom] [↑ Top]

Credits & References

• EasyMDE
• Highlight.js
• StackEdit+
• stackedit.js

[↓ Bottom] [↑ Top]

License

• This project is distributed under the MIT License

[↑ Top]

---