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 !
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.
- ❌
stackedit.netis gone, sad 🙁 - ✔️ yet there are
stackedit.ioandstackedit.cnto replace it - ❌
stackedit.iohas basic features only - ✔️ but
stackedit.iois in English - ❌
stackedit.netis in Chinese - ✔️ but
stackedit.nethas extra features and themes
Overall:
- ✅
stackedit.iois 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.netdon'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 !
- 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
EasyMDElocally 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:
EasyMDELive DemoStackEditOnline App (English)StackEdit+Online App (Chinese)
Configurable buttons of MD editors injected into the textarea editing toolbar.
Preview of Emoji Picker.
Preview of Font Awesome Icons Picker.
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.
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 Editing Options
Follow the explanations to configure and preview the MD editor(s) of your preference.
Setup Rendering Options
This section allows you to enable and parametrize custom rendering of markdown fields that will override the original KB display.
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
HighlightCodeSyntaxplugin (if installed) for rendering purposes. - May conflict with or override the functionality of the
MarkdownPlusplugin when the rendering option is turned on.
- Can utilize the
- Core Files & Templates
0Template 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_USis 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 translationsare available for them.
- Im[F(x)] - Author
- Contributors welcome for translations !
- EasyMDE
- Highlight.js
- stackedit.js
- StackEdit
- StackEdit+
- FG Emoji Picker
- FA Icons Picker
- Twemoji Color Font
- This project is distributed under the MIT License
[↑ Top]
