xref: /plugin/mikioplugin/README.md (revision 682e10f8bea3826e4054d0e52648e23f736f5b89)
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-04-19_**
27
28  - Fixed images not always being contained within elements such as card headers [#9](https://github.com/nomadjimbob/mikioplugin/issues/9)
29
30- **_2021-03-05_**
31
32  - Added support for custom element types and styling [#6](https://github.com/nomadjimbob/mikioplugin/issues/6)
33
34- **_2021-03-02_**
35  - Fixed a dokuwiki rendering issue in card bodies [#7](https://github.com/nomadjimbob/mikioplugin/issues/7)
36  - Fixed a text alignment not being applied in alerts [#8](https://github.com/nomadjimbob/mikioplugin/issues/8)
37
38## Links
39
40- DokuWiki Plugin Page: (http://dokuwiki.org/plugin:mikioplugin)
41- Download: (https://github.com/nomadjimbob/mikioplugin/releases/latest)
42- Docs: (https://github.com/nomadjimbob/mikioplugin/wiki)
43- Donate: (https://www.ko-fi.com/nomadjimbob)
44- License: (https://raw.githubusercontent.com/nomadjimbob/mikioplugin/master/LICENSE)
45
46## Contributing
47
48Any contributions are appreciated. Please feel free to reach out to me at james.collins@outlook.com.au
49