Skip to content

nomadjimbob/mikio

Repository files navigation

Mikio — DokuWiki Template

Mikio screenshot

Mikio is a modern DokuWiki template with a clean, Bootstrap-style design, flexible navigation, and full dark-mode support.
It’s built to make your wiki look like a polished website while staying lightweight, responsive, and configurable.


✨ 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

  1. Use the Theme Manager in DokuWiki to search for mikio and install the current release.

(Alternative) Copy the mikio folder from GitHub into lib/tpl/mikio to try the latest (may be less stable).

  1. In Admin → Configuration Manager → Template, select mikio.

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

💡 Want Bootstrap-style components inside your wiki pages?
Install the Mikio Plugin.


📖 Documentation

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

👉 Mikio Wiki


🛠️ 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? 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 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 LICENSE for details.


⭐ Like Mikio?

If this template makes your wiki better, consider starring the repo — it helps others discover it!

About

Customizable, Bootstrap 4 inspired template for Dokuwiki

Resources

License

Stars

Watchers

Forks

Contributors 6