xref: /plugin/mikioplugin/README.md (revision 84838f32822bfb3259fb16871bdfa417bb3362cf) 
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- **_2021-11-13_**
27  - Carousel control colors can now be customized
28  - Carousel now supports circle indicators
29  - Dynamically build and fullscreen carousels now supported
30  - SyntaxRender method now correctly converts tagName to methodNames
31
32- **_2021-08-11_**
33
34  - Replace Windows directory separator in CSS paths
35  - Fixed path check in LESS engine on Windows
36  - Recompiled CSS
37  - Fixed PHP warnings
38
39- **_2021-08-10_**
40
41  - Button outline styling fix [#12](https://github.com/nomadjimbob/mikioplugin/issues/12)
42  - Added small margin to left and right of buttons
43
44- **_2021-07-13_**
45
46  - Element class shortcuts (eg text-center) working again
47  - LESS engine updated to match the Mikio theme
48  - LESS fallback to CSS
49
50- **_2021-04-23_**
51
52  - 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
53  - Adding a card-footer element inside a card-body element will now work. This fixes inside card elements
54  - Cards and Carousel images are now contained inside the element instead of covering the element
55  - Added `cover` attributes to Card and Carousel for images to cover element instead of being contained
56  - Height attribute bugfix for placeholders
57
58- **_2021-04-19_**
59
60  - Fixed images not always being contained within elements such as card headers [#9](https://github.com/nomadjimbob/mikioplugin/issues/9)
61
62- **_2021-03-05_**
63
64  - Added support for custom element types and styling [#6](https://github.com/nomadjimbob/mikioplugin/issues/6)
65
66- **_2021-03-02_**
67  - Fixed a dokuwiki rendering issue in card bodies [#7](https://github.com/nomadjimbob/mikioplugin/issues/7)
68  - Fixed a text alignment not being applied in alerts [#8](https://github.com/nomadjimbob/mikioplugin/issues/8)
69
70## Links
71
72- DokuWiki Plugin Page: (http://dokuwiki.org/plugin:mikioplugin)
73- Download: (https://github.com/nomadjimbob/mikioplugin/releases/latest)
74- Docs: (https://github.com/nomadjimbob/mikioplugin/wiki)
75- Donate: (https://www.ko-fi.com/nomadjimbob)
76- License: (https://raw.githubusercontent.com/nomadjimbob/mikioplugin/master/LICENSE)
77
78## Contributing
79
80Any contributions are appreciated. Please feel free to reach out to me at james.collins@outlook.com.au
81