====== Mikio Template ======

---- template ----
description   : Mikio is a Bootstrap 4 style template with a hero element and dark mode support
author        : nomadjimbob
email         : james.collins@outlook.com.au
lastupdate_dt : 2025-10-01
compatible    : Igor, Hogfather, Greebo, Jack Jackrum, Kaos, Librarian
depends       :
conflicts     : # prefix templates by template:
similar       :
screenshot_img: https://raw.githubusercontent.com/nomadjimbob/mikio/master/images/screenshot.png
tags          : bootstrap, responsive, sidebar, modern, clean, css3, customizable, dark, dark-mode, mobile, print, semantic, themes, hero

downloadurl   : https://github.com/nomadjimbob/mikio/zipball/master
bugtracker    : https://github.com/nomadjimbob/mikio/issues
sourcerepo    : https://github.com/nomadjimbob/mikio/
----

===== Note =====

The 2025-04-24 release includes significant changes to styling and code. While it has been tested, there may be some bugs that I have missed. If you find anything that’s not working right, please [[#support|file an issue]].


===== ✨ Features =====

  * **Modern Bootstrap styling** with dark mode
  * **Configurable navbar** with dropdowns, sub-menus, custom slots
  * **Hero element** with title, subtitle, images, and colour overrides
  * **Flexible sidebars** (left/right, sticky, mobile collapse)
  * **Typeahead search** with optional suggestions
  * **Breadcrumbs & You Are Here** (separate, configurable)
  * **Tags integration** in hero or sidebar
  * **Floating page tools** and full-height TOC
  * **Icon engine** (FontAwesome 4/5, Bootstrap Icons, Elusive 2, or custom sets)
  * **Customisable page footer info text**
  * **Compatibility with popular plugins** (Translate, FastWiki, BookCreator, Tag, Approve, DO, VersionSwitcher, etc.)
  * **Dark-mode logo support** for seamless theming

----

===== 🚀 Quick Start =====

  - Use the **Theme Manager** in DokuWiki to search for **mikio** and install the current release.  
    > (Alternative) Copy the ''mikio'' folder from [[https://github.com/nomadjimbob/mikio|GitHub]] into ''lib/tpl/mikio'' to try the latest (may be less stable).

  - In **Admin → Configuration Manager → Template**, select **mikio**.

  - (Optional) Adjust colours, width, and dark-mode preferences under **Template Style Settings**.

> 💡 Want Bootstrap-style components inside your wiki pages? Install the [[https://github.com/nomadjimbob/mikioplugin|Mikio Plugin]].

----

===== 📖 Documentation =====

The README is just the start - full docs and configuration reference live in the wiki:

👉 [[https://github.com/nomadjimbob/mikio/wiki|Mikio Wiki]]

  * [[https://github.com/nomadjimbob/mikio/wiki/Configuration|Configuration Guide]]
  * [[https://github.com/nomadjimbob/mikio/wiki/Hero|Hero]]
  * [[https://github.com/nomadjimbob/mikio/wiki/Macros|Macros]]
  * [[https://github.com/nomadjimbob/mikio/wiki/Configuration#navbar|Navbar]]
  * [[https://github.com/nomadjimbob/mikio/wiki/Configuration#sidebars|Sidebars]]
  * [[https://github.com/nomadjimbob/mikio/wiki/Icon-Engine|Icon Engine]]
  * [[https://github.com/nomadjimbob/mikio/wiki/Configuration#custom-page-footer-info-text|Custom Footer Text]]
  * [[https://github.com/nomadjimbob/mikio/wiki#breaking-changes|Breaking Changes]]
  * [[https://github.com/nomadjimbob/mikio/releases|Releases]]

----

===== 🛠️ Compatibility =====

  * Works with recent DokuWiki releases (incl. //Librarian//).
  * Fully tested with PHP 8.2.
  * Designed to play nicely with popular plugins:
    * Translate
    * FastWiki
    * BookCreator
    * Tag
    * Approve
    * DO
    * VersionSwitcher

**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.

----

===== 🤝 Contributing =====

  * **Found a bug or want a feature?** [[https://github.com/nomadjimbob/mikio/issues|Open an issue]].
  * **Want to contribute code?** Submit a pull request — please include a clear description and screenshots if UI is affected.
  * **Translations welcome!** Language files are simple to add, see existing ones in ''/lang''.

----

===== 📦 Releases =====

You’ll always find the most recent changes in [[https://github.com/nomadjimbob/mikio/releases|Releases]].  
The ''main'' branch may include features still under test.

----

===== Third Party Libraries =====

This template uses a [[https://github.com/nomadjimbob/simple_html_dom|modified version]] of [[https://sourceforge.net/projects/simplehtmldom/|simple_html_dom]]

----

===== 📄 License =====

Released under the GPLv2.  
See [[https://github.com/nomadjimbob/mikio/blob/main/LICENSE.md|LICENSE]] for details.

----

===== Support =====

  * If you think you have found a problem, or would like to see a feature, please [[https://github.com/nomadjimbob/mikio/issues|open an issue]]
  * If you are a coder, feel free to create a pull request, but please be detailed about your changes!

----

===== Applause =====

This is really a modern, complete template, with very high flexibility and customizability. (Look at those options to customize for style.ini!) Also it's the first template I have seen with "Hero element" support. And there are quite a few positions to insert included pages as page/content header/footers. I appreciate the great work of the developer.  --- [[user>MilchFlasche|milchflasche]] //2020-07-30 03:42//
> I have used this template in my two language learning sites: http://taigi123.ga/ http://hakka123.ga/ (written in some East Asian languages and Hanzi script) --- [[user>MilchFlasche|milchflasche]] //2020-09-17 04:58//