1# Mikio — DokuWiki Template 2 3<p align="center"> 4 <img src="https://raw.githubusercontent.com/nomadjimbob/mikio/main/images/screenshot.png" alt="Mikio screenshot" width="880"> 5</p> 6 7**Mikio** is a modern [DokuWiki](https://www.dokuwiki.org/) template with a clean, Bootstrap-style design, flexible navigation, and full dark-mode support. 8It’s built to make your wiki look like a polished website while staying lightweight, responsive, and configurable. 9 10--- 11 12## ✨ Features 13 14- **Modern Bootstrap styling** with dark mode 15- **Configurable navbar** with dropdowns, sub-menus, custom slots 16- **Hero element** with title, subtitle, images, and colour overrides 17- **Flexible sidebars** (left/right, sticky, mobile collapse) 18- **Typeahead search** with optional suggestions 19- **Breadcrumbs & You Are Here** (separate, configurable) 20- **Tags integration** in hero or sidebar 21- **Floating page tools** and full-height TOC 22- **Icon engine** (FontAwesome 4/5, Bootstrap Icons, Elusive 2, or custom sets) 23- **Customisable page footer info text** 24- **Compatibility with popular plugins** (Translate, FastWiki, BookCreator, Tag, Approve, DO, VersionSwitcher, etc.) 25- **Dark-mode logo support** for seamless theming 26 27--- 28 29## �� Quick Start 30 311. Use the **Theme Manager** in DokuWiki to search for **mikio** and install the current release. 32 33> (Alternative) Copy the `mikio` folder from [GitHub](https://github.com/nomadjimbob/mikio) into `lib/tpl/mikio` to try the latest (may be less stable). 34 352. In **Admin → Configuration Manager → Template**, select **mikio**. 36 373. (Optional) Adjust colours, width, and dark-mode preferences under **Template Style Settings**. 38 39> �� Want Bootstrap-style components inside your wiki pages? 40> Install the [Mikio Plugin](https://github.com/nomadjimbob/mikioplugin). 41 42--- 43 44## �� Documentation 45 46The README is just the start - full docs, guides, and configuration reference live in the wiki: 47 48�� [Mikio Wiki](https://github.com/nomadjimbob/mikio/wiki) 49 50- [Configuration Guide](https://github.com/nomadjimbob/mikio/wiki/Configuration) 51- [Hero](https://github.com/nomadjimbob/mikio/wiki/Hero) 52- [Macros](https://github.com/nomadjimbob/mikio/wiki/Macros) 53- [Navbar](https://github.com/nomadjimbob/mikio/wiki/Configuration#navbar) 54- [Sidebars](https://github.com/nomadjimbob/mikio/wiki/Configuration#sidebars) 55- [Icon Engine](https://github.com/nomadjimbob/mikio/wiki/Icon-Engine) 56- [Custom Footer Text](https://github.com/nomadjimbob/mikio/wiki/Configuration#custom-page-footer-info-text) 57- [Breaking Changes](https://github.com/nomadjimbob/mikio/wiki#breaking-changes) 58- [Releases](https://github.com/nomadjimbob/mikio/releases) 59 60--- 61 62## ��️ Compatibility 63 64- Works with recent DokuWiki releases (incl. *Librarian*). 65- Fully tested with PHP 8.2. 66- Designed to play nicely with popular plugins: 67 - Translate 68 - FastWiki 69 - BookCreator 70 - Tag 71 - Approve 72 - DO 73 - VersionSwitcher 74 75**Comment Syntax support** converts custom control macros such as the Mikio macro `~~hero-image ...~~` into comments. If you plan to use this extension on your site, you will need to use the alternative macro format of `-~hero-image ...~-` for Mikio to detect the information. 76 77--- 78 79## �� Contributing 80 81- **Found a bug or want a feature?** [Open an issue](https://github.com/nomadjimbob/mikio/issues). 82- **Want to contribute code?** Submit a pull request — please include a clear description and screenshots if UI is affected. 83- **Translations welcome!** Language files are simple to add, see existing ones in `/lang`. 84 85--- 86 87## �� Releases 88 89You’ll always find the most recent changes in [Releases](https://github.com/nomadjimbob/mikio/releases). 90The `main` branch may include features still under test. 91 92--- 93 94## �� License 95 96Released under the GPLv2. 97See [LICENSE](./LICENSE) for details. 98 99--- 100 101### ⭐ Like Mikio? 102If this template makes your wiki better, consider starring the repo — it helps others discover it!
