xref: /plugin/mikioplugin/README.md (revision 616a90c2c396c80c8a17bde810bae8aac7cef8d9)
1<img src="https://raw.githubusercontent.com/nomadjimbob/nomadjimbob/master/wiki/mikioplugin/images/mikio_plugin_header.png">
2
3[![License: GPL-2](https://img.shields.io/github/license/nomadjimbob/mikioplugin?color=blue)](LICENSE)
4[![Github all releases](https://img.shields.io/github/downloads/nomadjimbob/mikioplugin/total.svg)](https://github.com/nomadjimbob/mikioplugin/releases/)
5[![saythanks](https://img.shields.io/badge/say-thanks-ff69b4.svg)](https://saythanks.io/to/james.collins%40outlook.com.au)
6[![Donate to this project using Ko-Fi](https://img.shields.io/badge/kofi-donate-yellow.svg)](https://www.ko-fi.com/nomadjimbob)
7
8Mikio Plugin adds a heap of layout and Bootstrap 4 elements that can be used on your [DokuWiki](http://dokuwiki.org/) pages.
9
10This plugin can be used by itself, however is designed to complement the [Mikio DokuWiki theme](http://dokuwiki.org/template:mikio).
11
12## Setting Up
13
14Download the [latest release](https://github.com/nomadjimbob/mikioplugin/releases/latest) and place it in the\
15\
16:file_folder: dokuwiki\
17&nbsp;&nbsp;&nbsp;&nbsp;:file_folder: lib\
18&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;:file_folder: plugins
19
20directory of your DokuWiki installation.
21
22Sometimes GitHub releases change the name of the mikioplugin directory, so make sure that the directory is `mikioplugin` else you may see errors in DokuWiki.
23
24## Releases
25
26- **_2022-10-31_**
27  - Fixed 'link' type for Buttons
28  - Updated CSS to use CSS Variables to support switchable themes (darkmode)
29  - variables.css no longer included if the mikio template is installed, active and version 2022-10-31 or greator
30
31- **_2022-01-18_**
32  - Fixed accordian not rendering tables inside itself [#15](https://github.com/nomadjimbob/mikioplugin/issues/15). Thanks Melphios
33
34- **_2021-12-15_**
35  - Added `autoclose` attribute to Accordions to close any other open accordion items other than the one clicked by the user. Requested by eFreshman
36
37- **_2021-12-14_**
38  - Fix Carousel not containing image by default [#14](https://github.com/nomadjimbob/mikioplugin/issues/14). Thanks eFreshman
39
40- **_2021-12-13_**
41  - Fix Struct Plugin Aggregation [#13](https://github.com/nomadjimbob/mikioplugin/issues/13). Thanks eFreshman
42
43- **_2021-11-13_**
44  - Carousel control colors can now be customized
45  - Carousel now supports circle indicators
46  - Dynamically build and fullscreen carousels now supported
47  - SyntaxRender method now correctly converts tagName to methodNames
48
49- **_2021-08-11_**
50
51  - Replace Windows directory separator in CSS paths
52  - Fixed path check in LESS engine on Windows
53  - Recompiled CSS
54  - Fixed PHP warnings
55
56- **_2021-08-10_**
57
58  - Button outline styling fix [#12](https://github.com/nomadjimbob/mikioplugin/issues/12)
59  - Added small margin to left and right of buttons
60
61- **_2021-07-13_**
62
63  - Element class shortcuts (eg text-center) working again
64  - LESS engine updated to match the Mikio theme
65  - LESS fallback to CSS
66
67- **_2021-04-23_**
68
69  - Fixed Card element overflow issues. Cards will now be their own height when inside a row element. To force cards to all be the same height, wrap each card in a col element
70  - Adding a card-footer element inside a card-body element will now work. This fixes inside card elements
71  - Cards and Carousel images are now contained inside the element instead of covering the element
72  - Added `cover` attributes to Card and Carousel for images to cover element instead of being contained
73  - Height attribute bugfix for placeholders
74
75- **_2021-04-19_**
76
77  - Fixed images not always being contained within elements such as card headers [#9](https://github.com/nomadjimbob/mikioplugin/issues/9)
78
79- **_2021-03-05_**
80
81  - Added support for custom element types and styling [#6](https://github.com/nomadjimbob/mikioplugin/issues/6)
82
83- **_2021-03-02_**
84  - Fixed a dokuwiki rendering issue in card bodies [#7](https://github.com/nomadjimbob/mikioplugin/issues/7)
85  - Fixed a text alignment not being applied in alerts [#8](https://github.com/nomadjimbob/mikioplugin/issues/8)
86
87## Links
88
89- DokuWiki Plugin Page: (http://dokuwiki.org/plugin:mikioplugin)
90- Download: (https://github.com/nomadjimbob/mikioplugin/releases/latest)
91- Docs: (https://github.com/nomadjimbob/mikioplugin/wiki)
92- Donate: (https://www.ko-fi.com/nomadjimbob)
93- License: (https://raw.githubusercontent.com/nomadjimbob/mikioplugin/master/LICENSE)
94
95## Contributing
96
97Any contributions are appreciated. Please feel free to reach out to me at james.collins@outlook.com.au
98