diff --git a/README.md b/README.md index 4042c11..0cee5cd 100644 --- a/README.md +++ b/README.md @@ -85,6 +85,8 @@ So, you really need to try each of the editors for yourself ! ## Features +### ✨ 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 ! ✨ @@ -93,9 +95,10 @@ So, you really need to try each of the editors for yourself ! - All editors are configured to be [GFM](https://github.github.com/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. -- ✨ Configurable **Emoji Picker** button for editing toolbar of markdown textareas (also integrated into `EasyMDE`). ✨ -- ✨ Option for custom rendering of markdown fields (using `EasyMDE` locally with JavaScript). ✨ -- ✨ Rendering can be parametrized with theme, code highlight, and background transparency. ✨ +- ✨ 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](https://fontawesome.com/v4/icons/), since this is what Kanboard comes with. For a better preview and feel of the actual editors visit: - `EasyMDE` [Live Demo](https://stackblitz.com/edit/easymde/?file=index.html) @@ -106,49 +109,109 @@ 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.** +
+ +
+ +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") + +
-![preview easymde](Screenshots/preview-easymde.png "preview easymde") +
+ +StackEdit+ with side preview using the default dark theme. + -**StackEdit+ with side preview using the default dark theme.** +![preview stackedit plus](Screenshots/preview-editor-stackedit-plus.png "preview stackedit plus") -![preview stackedit plus](Screenshots/preview-stackedit-plus.png "preview stackedit plus") +
-**Example of task description tooltip rendered with EasyMDE.** +
+ +Example of task description tooltip rendered with EasyMDE. + -![preview tooltip render](Screenshots/preview-tootip-render.png "preview tooltip render") +![preview tooltip render](Screenshots/preview-render-tootip.png "preview tooltip render") + +

[↓ Bottom] [↑ Top]

-## Usage +## Configure -Go to `Settings` ⥂ `Wysiwyg MD Editor` +Go to `Settings` ⥂ `Wysiwyg MD Editor`. -Follow the explanations in `Setup Editing Options` to configure and preview the MD editor(s) of your preference. +
+ +Setup Symbol Picker Options + +Follow the explanations to configure and preview the symbol picker(s) of your preference. -![setup editing options](Screenshots/setup-editing-options.png "setup editing options") +![setup symbol picker options](Screenshots/setup-options-symbol-picker.png "setup symbol picker 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") +
+ +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 +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 +Compatibility - Requires [Kanboard](https://github.com/kanboard/kanboard "Kanboard - Kanban Project Management Software") ≥`1.2.33` - **Other Plugins & Action Plugins** @@ -160,7 +223,7 @@ The section `Setup Rendering Options` allows you to enable and parametrize custo
- Translations +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. diff --git a/Screenshots/preview-easymde.png b/Screenshots/preview-editor-easymde.png similarity index 100% rename from Screenshots/preview-easymde.png rename to Screenshots/preview-editor-easymde.png diff --git a/Screenshots/preview-stackedit-plus.png b/Screenshots/preview-editor-stackedit-plus.png similarity index 100% rename from Screenshots/preview-stackedit-plus.png rename to Screenshots/preview-editor-stackedit-plus.png diff --git a/Screenshots/preview-picker-emoji.png b/Screenshots/preview-picker-emoji.png new file mode 100644 index 0000000..1ac5913 Binary files /dev/null and b/Screenshots/preview-picker-emoji.png differ diff --git a/Screenshots/preview-picker-faicons.png b/Screenshots/preview-picker-faicons.png new file mode 100644 index 0000000..963b0bc Binary files /dev/null and b/Screenshots/preview-picker-faicons.png differ diff --git a/Screenshots/preview-tootip-render.png b/Screenshots/preview-render-tootip.png similarity index 100% rename from Screenshots/preview-tootip-render.png rename to Screenshots/preview-render-tootip.png diff --git a/Screenshots/setup-editing-options.png b/Screenshots/setup-editing-options.png deleted file mode 100644 index a8dc0d0..0000000 Binary files a/Screenshots/setup-editing-options.png and /dev/null differ diff --git a/Screenshots/setup-options-editing.png b/Screenshots/setup-options-editing.png new file mode 100644 index 0000000..a1452b0 Binary files /dev/null and b/Screenshots/setup-options-editing.png differ diff --git a/Screenshots/setup-options-rendering.png b/Screenshots/setup-options-rendering.png new file mode 100644 index 0000000..8f0b384 Binary files /dev/null and b/Screenshots/setup-options-rendering.png differ diff --git a/Screenshots/setup-options-symbol-picker.png b/Screenshots/setup-options-symbol-picker.png new file mode 100644 index 0000000..c61b6b6 Binary files /dev/null and b/Screenshots/setup-options-symbol-picker.png differ diff --git a/Screenshots/setup-rendering-options.png b/Screenshots/setup-rendering-options.png deleted file mode 100644 index bcd27c5..0000000 Binary files a/Screenshots/setup-rendering-options.png and /dev/null differ diff --git a/changelog.md b/changelog.md index 9057f67..ee18223 100644 --- a/changelog.md +++ b/changelog.md @@ -1,6 +1,12 @@ # Changelog +## v0.9.4 + +_(most recent changes are listed on top):_ +* Integrated a **Font Awesome Icons Picker** into `EasyMDE` and as an optional button in the markdown edit toolbar. +* Reworked settings sections layout and descriptions. + ## v0.9.3 _(most recent changes are listed on top):_