38
38
39
39
<h1 name =" user-content-readme-top " >Wysiwyg MD Editor plugin for Kanboard</h1 >
40
40
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.
43
43
Each editor may allow for different customizations of functionality, MD features, and UI themes.
44
+ Rendering can parametrize theme, code highlight, and background transparency.
44
45
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 !
47
49
48
50
<p align =" right " >[<a href =" #user-content-readme-bottom " >↓ ; Bottom</a >] [<a href =" #user-content-readme-top " >↑ ; Top</a >]</p >
49
51
50
52
## Features
51
53
54
+ ### ✨ Rendering options are available as of v.0.9.0 ! ✨
55
+
52
56
- Currently integrates the [ EasyMDE] ( https://github.com/Ionaru/easy-markdown-editor ) and [ StackEdit+] ( https://github.com/mafgwo/stackedit-plus ) markdown editors
53
57
- Both editors are configured to be [ GFM] ( https://github.github.com/gfm/ ) compatible
54
58
- Side preview is available, themes and various convenience options
55
59
- 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. ✨
56
62
57
63
For a better preview and feel of the actual editors visit:
58
64
- ` 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:
62
68
63
69
## Screenshots
64
70
65
- ** Configurable buttons of MD editors injected into the textarea editing toolbar.**
71
+ #### Configurable buttons of MD editors injected into the textarea editing toolbar.
66
72
67
73
![ textarea editing toolbar injected buttons] ( Screenshots/textarea-editing-toolbar-injected-buttons.png " textarea editing toolbar with injected MD editors buttons ")
68
74
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.
70
80
71
- ![ easymde preview] ( Screenshots/easymde- preview.png " easymde preview")
81
+ ![ preview stackedit plus ] ( Screenshots/preview-stackedit-plus .png " preview stackedit plus ")
72
82
73
- ** StackEdit+ with side preview using the default dark theme. **
83
+ #### Example of task description tooltip rendered with EasyMDE.
74
84
75
- ![ stackedit plus preview ] ( Screenshots/stackedit-plus-preview .png " stackedit plus preview ")
85
+ ![ preview tooltip render ] ( Screenshots/preview-tootip-render .png " preview tooltip render ")
76
86
77
87
<p align =" right " >[<a href =" #user-content-readme-bottom " >↓ ; Bottom</a >] [<a href =" #user-content-readme-top " >↑ ; Top</a >]</p >
78
88
79
89
## Usage
80
90
81
91
Go to ` Settings ` ⥂ ; ` Wysiwyg MD Editor `
82
92
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 ")
84
100
85
101
<p align =" right " >[<a href =" #user-content-readme-bottom " >↓ ; Bottom</a >] [<a href =" #user-content-readme-top " >↑ ; Top</a >]</p >
86
102
@@ -98,7 +114,8 @@ Follow the explanations to configure and preview the MD editor(s) of your prefer
98
114
99
115
- Requires [ Kanboard] ( https://github.com/kanboard/kanboard " Kanboard - Kanban Project Management Software ") ≥` 1.2.33 `
100
116
- ** 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.
102
119
- ** Core Files & Templates**
103
120
- ` 0 ` Template override
104
121
- _ No database changes_
0 commit comments