xref: /plugin/mikioplugin/README.md (revision 99416241f706c75c477a37176b5375cb0b132ba4) 
1<img src="https://github.com/nomadjimbob/nomadjimbob/raw/master/images/mikioplugin/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
13## Setting Up
14
15Download the [latest release](https://github.com/nomadjimbob/mikioplugin/releases/latest) and place it in the\
16\
17:file_folder: dokuwiki\
18&nbsp;&nbsp;&nbsp;&nbsp;:file_folder: lib\
19&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;:file_folder: plugins
20
21directory of your DokuWiki installation.
22
23Sometimes GitHub releases change the name of the mikioplugin directory, so make sure that the directory is `mikioplugin` else you may see errors in DokuWiki.
24
25
26## Links
27
28  * DokuWiki Plugin Page: (http://dokuwiki.org/plugin:mikioplugin)
29  * Download: (https://github.com/nomadjimbob/mikioplugin/releases/latest)
30  * Docs: (https://github.com/nomadjimbob/mikioplugin/wiki)
31  * Donate: (https://www.ko-fi.com/nomadjimbob)
32  * License: (https://raw.githubusercontent.com/nomadjimbob/mikioplugin/master/LICENSE)
33
34## Contributing
35
36Any contributions are appreciated. Please feel free to reach out to me at james.collins@outlook.com.au or on [Discord](https://discord.com/channels/@me/672393169517674506) if you're interested in helping out with this project.
37