xref: /plugin/mikioplugin/README.md (revision 54c8671bf90f1b1fe6da38cdc5ab419cc7ebce54)
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[![saythanks](https://img.shields.io/badge/say-thanks-ff69b4.svg)](https://saythanks.io/to/james.collins%40outlook.com.au)
5
6Mikio Plugin adds a heap of layout and Bootstrap 4 elements that can be used on your [DokuWiki](http://dokuwiki.org/) pages.
7
8This plugin can be used by itself, however is designed to complement the [Mikio DokuWiki template](http://dokuwiki.org/template:mikio).
9
10## Updating Styles
11
12You can update the colors used by the elements by editing the `/assets/variables.css` file. From version 2022-10-31 onwards, the theme supports darkmode within browsers.
13
14If you have the [Mikio DokuWiki template](http://dokuwiki.org/template:mikio) 2022-10-31 onwards installed, the `/assetrs/variables.css` will be ignored as the template adds the variables itself. These can be edited using
15**Template Style Settings** in your sites **Administration** page.
16
17## Setting Up
18
19Download the [latest release](https://github.com/nomadjimbob/mikioplugin/releases/latest) and place it in the\
20\
21:file_folder: dokuwiki\
22&nbsp;&nbsp;&nbsp;&nbsp;:file_folder: lib\
23&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;:file_folder: plugins
24
25directory of your DokuWiki installation.
26
27Sometimes GitHub releases change the name of the mikioplugin directory, so make sure that the directory is `mikioplugin` else you may see errors in DokuWiki.
28
29## Releases
30
31-   **_2023-09-03_**
32
33    -   Fixed card height issues on smaller viewports.
34    -   Fixed columns not stacking on small viewports when using sizing. [#21](https://github.com/nomadjimbob/mikioplugin/issues/21). Thanks armandostyl
35
36-   **_2023-06-16_**
37
38    -   Fixed spacing issues with listgroup items with mixed styles. [#20](https://github.com/nomadjimbob/mikioplugin/issues/20). Thanks armandostyl
39
40-   **_2023-06-06_**
41
42    -   Added Nav item to create dropdown navigation items. [#18](https://github.com/nomadjimbob/mikioplugin/issues/18). Thanks armandostyl
43    -   Added support for elements in sidebars
44
45-   **_2023-05-20_**
46
47    -   AccordionItem, Alert, Blockquote, Card and CardBody now support containing 'protected' type which fixes some elements not rendering correctly (ie <&lt>code<&gt>)
48
49-   **_2023-05-19_**
50
51    -   Updated to include a polyfill for array_key_first if PHP < 7.3
52
53-   **_2022-10-31_**
54
55    -   Fixed 'link' type for Buttons
56    -   Updated CSS to use CSS Variables (supporting switchable themes and style editor within Mikio template). Thanks chrbinder.
57    -   variables.css no longer included if the mikio template is installed, active and version 2022-10-31 or greator
58
59-   **_2022-01-18_**
60
61    -   Fixed accordian not rendering tables inside itself [#15](https://github.com/nomadjimbob/mikioplugin/issues/15). Thanks Melphios
62
63-   **_2021-12-15_**
64
65    -   Added `autoclose` attribute to Accordions to close any other open accordion items other than the one clicked by the user. Requested by eFreshman
66
67-   **_2021-12-14_**
68
69    -   Fix Carousel not containing image by default [#14](https://github.com/nomadjimbob/mikioplugin/issues/14). Thanks eFreshman
70
71-   **_2021-12-13_**
72
73    -   Fix Struct Plugin Aggregation [#13](https://github.com/nomadjimbob/mikioplugin/issues/13). Thanks eFreshman
74
75-   **_2021-11-13_**
76
77    -   Carousel control colors can now be customized
78    -   Carousel now supports circle indicators
79    -   Dynamically build and fullscreen carousels now supported
80    -   SyntaxRender method now correctly converts tagName to methodNames
81
82-   **_2021-08-11_**
83
84    -   Replace Windows directory separator in CSS paths
85    -   Fixed path check in LESS engine on Windows
86    -   Recompiled CSS
87    -   Fixed PHP warnings
88
89-   **_2021-08-10_**
90
91    -   Button outline styling fix [#12](https://github.com/nomadjimbob/mikioplugin/issues/12)
92    -   Added small margin to left and right of buttons
93
94-   **_2021-07-13_**
95
96    -   Element class shortcuts (eg text-center) working again
97    -   LESS engine updated to match the Mikio theme
98    -   LESS fallback to CSS
99
100-   **_2021-04-23_**
101
102    -   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
103    -   Adding a card-footer element inside a card-body element will now work. This fixes inside card elements
104    -   Cards and Carousel images are now contained inside the element instead of covering the element
105    -   Added `cover` attributes to Card and Carousel for images to cover element instead of being contained
106    -   Height attribute bugfix for placeholders
107
108-   **_2021-04-19_**
109
110    -   Fixed images not always being contained within elements such as card headers [#9](https://github.com/nomadjimbob/mikioplugin/issues/9)
111
112-   **_2021-03-05_**
113
114    -   Added support for custom element types and styling [#6](https://github.com/nomadjimbob/mikioplugin/issues/6)
115
116-   **_2021-03-02_**
117    -   Fixed a dokuwiki rendering issue in card bodies [#7](https://github.com/nomadjimbob/mikioplugin/issues/7)
118    -   Fixed a text alignment not being applied in alerts [#8](https://github.com/nomadjimbob/mikioplugin/issues/8)
119
120## Links
121
122-   DokuWiki Plugin Page: (http://dokuwiki.org/plugin:mikioplugin)
123-   Download: (https://github.com/nomadjimbob/mikioplugin/releases/latest)
124-   Docs: (https://github.com/nomadjimbob/mikioplugin/wiki)
125-   Donate: (https://www.ko-fi.com/nomadjimbob)
126-   License: (https://raw.githubusercontent.com/nomadjimbob/mikioplugin/master/LICENSE)
127
128## Contributing
129
130Any contributions are appreciated. Please feel free to reach out to me at james.collins@outlook.com.au
131