diff --git a/Plugin.php b/Plugin.php index 4bfc101..7aa6e9e 100644 --- a/Plugin.php +++ b/Plugin.php @@ -108,7 +108,7 @@ public function getPluginAuthor() public function getPluginVersion() { - return '0.5.4'; + return '0.9.0'; } public function getCompatibleVersion() diff --git a/README.md b/README.md index f653c9a..9dd4095 100644 --- a/README.md +++ b/README.md @@ -38,21 +38,27 @@

Wysiwyg MD Editor plugin for Kanboard

-Integrates external MD editors into Kanboard in order to conveniently edit/preview -(and eventually render) the markdown textareas in the Kanboard interface. +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. -- [x] If you like it and use it, please, give a :star: ! -- [x] If you want a new language pack added or an existing one corrected, please, post a PR ! +✅ 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](https://github.com/Ionaru/easy-markdown-editor) and [StackEdit+](https://github.com/mafgwo/stackedit-plus) markdown editors - Both editors are configured to be [GFM](https://github.github.com/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](https://stackblitz.com/edit/easymde/?file=index.html) @@ -62,17 +68,21 @@ For a better preview and feel of the actual editors visit: ## Screenshots -**Configurable buttons of MD editors injected into the textarea editing toolbar.** +#### Configurable buttons of MD editors injected into the textarea editing toolbar. ![textarea editing toolbar injected buttons](Screenshots/textarea-editing-toolbar-injected-buttons.png "textarea editing toolbar with injected MD editors buttons") -**EasyMDE with side preview using the dimmed theme.** +#### EasyMDE with side preview using the dimmed theme. + +![preview easymde](Screenshots/preview-easymde.png "preview easymde") + +#### StackEdit+ with side preview using the default dark theme. -![easymde preview](Screenshots/easymde-preview.png "easymde preview") +![preview stackedit plus](Screenshots/preview-stackedit-plus.png "preview stackedit plus") -**StackEdit+ with side preview using the default dark theme.** +#### Example of task description tooltip rendered with EasyMDE. -![stackedit plus preview](Screenshots/stackedit-plus-preview.png "stackedit plus preview") +![preview tooltip render](Screenshots/preview-tootip-render.png "preview tooltip render")

[↓ Bottom] [↑ Top]

@@ -80,7 +90,13 @@ For a better preview and feel of the actual editors visit: Go to `Settings` ⥂ `Wysiwyg MD Editor` -Follow the explanations to configure and preview the MD editor(s) of your preference. +Follow the explanations in `Setup Editing Options` to configure and preview the MD editor(s) of your preference. + +![setup editing options](Screenshots/setup-editing-options.png "setup editing options") + +The section `Setup Rendering Options` allows you to enable and parametrize custom rendering of markdown fields that will override the original KB display. + +![setup rendering options](Screenshots/setup-rendering-options.png "setup rendering options")

[↓ Bottom] [↑ Top]

@@ -98,7 +114,8 @@ Follow the explanations to configure and preview the MD editor(s) of your prefer - Requires [Kanboard](https://github.com/kanboard/kanboard "Kanboard - Kanban Project Management Software") ≥`1.2.33` - **Other Plugins & Action Plugins** - - _No known issues_ + - 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_ diff --git a/Screenshots/easymde-preview.png b/Screenshots/easymde-preview.png deleted file mode 100644 index 2173172..0000000 Binary files a/Screenshots/easymde-preview.png and /dev/null differ diff --git a/Screenshots/preview-easymde.png b/Screenshots/preview-easymde.png new file mode 100644 index 0000000..52a0ff7 Binary files /dev/null and b/Screenshots/preview-easymde.png differ diff --git a/Screenshots/preview-stackedit-plus.png b/Screenshots/preview-stackedit-plus.png new file mode 100644 index 0000000..5694e35 Binary files /dev/null and b/Screenshots/preview-stackedit-plus.png differ diff --git a/Screenshots/preview-tootip-render.png b/Screenshots/preview-tootip-render.png new file mode 100644 index 0000000..316b921 Binary files /dev/null and b/Screenshots/preview-tootip-render.png differ diff --git a/Screenshots/setup-editing-options.png b/Screenshots/setup-editing-options.png new file mode 100644 index 0000000..a8dc0d0 Binary files /dev/null and b/Screenshots/setup-editing-options.png differ diff --git a/Screenshots/setup-rendering-options.png b/Screenshots/setup-rendering-options.png new file mode 100644 index 0000000..bcd27c5 Binary files /dev/null and b/Screenshots/setup-rendering-options.png differ diff --git a/Screenshots/stackedit-plus-preview.png b/Screenshots/stackedit-plus-preview.png deleted file mode 100644 index 890132d..0000000 Binary files a/Screenshots/stackedit-plus-preview.png and /dev/null differ diff --git a/changelog.md b/changelog.md index 19cb5c4..6e1c680 100644 --- a/changelog.md +++ b/changelog.md @@ -1,6 +1,14 @@ # Changelog +## v0.9.0 + +_(most recent changes are listed on top):_ +* Option for custom rendering of markdown fields (using `EasyMDE` locally with JavaScript). +* Rendering can be parametrized with theme, code highlight, and background transparency. +* Style fixes for EasyMDE preview and rendering. +* Updates for locale texts. + ## v0.5.4 _(most recent changes are listed on top):_