Skip to content

Commit 29f09d3

Browse files
committed
* updates for screenshots, changelog, README
* increasing plugin version to v.0.9.0
1 parent 01d8182 commit 29f09d3

10 files changed

+37
-12
lines changed

Plugin.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ public function getPluginAuthor()
108108

109109
public function getPluginVersion()
110110
{
111-
return '0.5.4';
111+
return '0.9.0';
112112
}
113113

114114
public function getCompatibleVersion()

README.md

+28-11
Original file line numberDiff line numberDiff line change
@@ -38,21 +38,27 @@
3838

3939
<h1 name="user-content-readme-top">Wysiwyg MD Editor plugin for Kanboard</h1>
4040

41-
Integrates external MD editors into Kanboard in order to conveniently edit/preview
42-
(and eventually render) the markdown textareas in the Kanboard interface.
41+
Integrates external MD editors into Kanboard in order to conveniently edit and preview
42+
the markdown textareas, as well as render the markdown fields in the Kanboard interface.
4343
Each editor may allow for different customizations of functionality, MD features, and UI themes.
44+
Rendering can parametrize theme, code highlight, and background transparency.
4445

45-
- [x] If you like it and use it, please, give a :star: !
46-
- [x] If you want a new language pack added or an existing one corrected, please, post a PR !
46+
✅ If you want a new language pack added or an existing one corrected, please, post a PR !
47+
48+
✅ If you like and use the plugin, please, give a ⭐ to this repository !
4749

4850
<p align="right">[<a href="#user-content-readme-bottom">&#8595; Bottom</a>] [<a href="#user-content-readme-top">&#8593; Top</a>]</p>
4951

5052
## Features
5153

54+
### ✨ Rendering options are available as of v.0.9.0 ! ✨
55+
5256
- Currently integrates the [EasyMDE](https://github.com/Ionaru/easy-markdown-editor) and [StackEdit+](https://github.com/mafgwo/stackedit-plus) markdown editors
5357
- Both editors are configured to be [GFM](https://github.github.com/gfm/) compatible
5458
- Side preview is available, themes and various convenience options
5559
- Configurable buttons to inject into the KB editing toolbar of markdown textareas
60+
- ✨ Option for custom rendering of markdown fields (using `EasyMDE` locally with JavaScript). ✨
61+
- ✨ Rendering can be parametrized with theme, code highlight, and background transparency. ✨
5662

5763
For a better preview and feel of the actual editors visit:
5864
- `EasyMDE` [Live Demo](https://stackblitz.com/edit/easymde/?file=index.html)
@@ -62,25 +68,35 @@ For a better preview and feel of the actual editors visit:
6268

6369
## Screenshots
6470

65-
**Configurable buttons of MD editors injected into the textarea editing toolbar.**
71+
#### Configurable buttons of MD editors injected into the textarea editing toolbar.
6672

6773
![textarea editing toolbar injected buttons](Screenshots/textarea-editing-toolbar-injected-buttons.png "textarea editing toolbar with injected MD editors buttons")
6874

69-
**EasyMDE with side preview using the dimmed theme.**
75+
#### EasyMDE with side preview using the dimmed theme.
76+
77+
![preview easymde](Screenshots/preview-easymde.png "preview easymde")
78+
79+
#### StackEdit+ with side preview using the default dark theme.
7080

71-
![easymde preview](Screenshots/easymde-preview.png "easymde preview")
81+
![preview stackedit plus](Screenshots/preview-stackedit-plus.png "preview stackedit plus")
7282

73-
**StackEdit+ with side preview using the default dark theme.**
83+
#### Example of task description tooltip rendered with EasyMDE.
7484

75-
![stackedit plus preview](Screenshots/stackedit-plus-preview.png "stackedit plus preview")
85+
![preview tooltip render](Screenshots/preview-tootip-render.png "preview tooltip render")
7686

7787
<p align="right">[<a href="#user-content-readme-bottom">&#8595; Bottom</a>] [<a href="#user-content-readme-top">&#8593; Top</a>]</p>
7888

7989
## Usage
8090

8191
Go to `Settings` &#10562; `Wysiwyg MD Editor`
8292

83-
Follow the explanations to configure and preview the MD editor(s) of your preference.
93+
Follow the explanations in `Setup Editing Options` to configure and preview the MD editor(s) of your preference.
94+
95+
![setup editing options](Screenshots/setup-editing-options.png "setup editing options")
96+
97+
The section `Setup Rendering Options` allows you to enable and parametrize custom rendering of markdown fields that will override the original KB display.
98+
99+
![setup rendering options](Screenshots/setup-rendering-options.png "setup rendering options")
84100

85101
<p align="right">[<a href="#user-content-readme-bottom">&#8595; Bottom</a>] [<a href="#user-content-readme-top">&#8593; Top</a>]</p>
86102

@@ -98,7 +114,8 @@ Follow the explanations to configure and preview the MD editor(s) of your prefer
98114

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

Screenshots/easymde-preview.png

-277 KB
Binary file not shown.

Screenshots/preview-easymde.png

250 KB
Loading
411 KB
Loading

Screenshots/preview-tootip-render.png

95 KB
Loading

Screenshots/setup-editing-options.png

85.1 KB
Loading
38.8 KB
Loading
-409 KB
Binary file not shown.

changelog.md

+8
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
11
# Changelog
22

33

4+
## v0.9.0
5+
6+
_(most recent changes are listed on top):_
7+
* Option for custom rendering of markdown fields (using `EasyMDE` locally with JavaScript).
8+
* Rendering can be parametrized with theme, code highlight, and background transparency.
9+
* Style fixes for EasyMDE preview and rendering.
10+
* Updates for locale texts.
11+
412
## v0.5.4
513

614
_(most recent changes are listed on top):_

0 commit comments

Comments
 (0)