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