MokoOnyx/README.md

# MokoOnyx

MokoOnyx - Joomla site template (successor to MokoCassiopeia)

![License](https://img.shields.io/badge/license-GPL--3.0--or--later-green?style=flat-square) ![Wiki](https://img.shields.io/badge/wiki-MokoOnyx-blue?style=flat-square)


A modern, lightweight Joomla site template built on Cassiopeia with Font Awesome 7, Bootstrap 5, dark mode, and analytics integrations.

---

| | |
|---|---|
| **Type** | Joomla Site Template |
| **Version** | 02.05.00 |
| **Joomla** | 5.x / 6.x |
| **PHP** | 8.1+ |
| **License** | GPL-3.0-or-later |
| **Replaces** | MokoCassiopeia (auto-migrates on install) |
| **Repository** | [Gitea](https://git.mokoconsulting.tech/MokoConsulting/MokoOnyx) (primary) |

---

## Overview

MokoOnyx is an enhancement layer built on Joomla's Cassiopeia template. It maintains minimal core overrides for maximum upgrade compatibility while adding modern features and integrations.

On install, MokoOnyx automatically migrates settings, content references, and custom files from MokoCassiopeia. After installing, MokoCassiopeia can be safely uninstalled.

---

## Features

| Feature | Description |
|---------|-------------|
| **Font Awesome 7** | Fully integrated into Joomla's asset manager with 2,000+ icons |
| **Bootstrap 5** | Extended utility classes and responsive grid system |
| **Dark Mode** | Built-in light/dark toggle with system preference detection |
| **Table of Contents** | Automatic TOC generation for long articles |
| **GTM / GA4** | Google Tag Manager and Analytics integration with smart visitor detection (login status, user group, page type) |
| **Template Overrides** | Overrides for all core Joomla modules, Community Builder, and DPCalendar |
| **Cassiopeia Base** | Minimal core overrides for maximum Joomla upgrade compatibility |

---

## Installation

1. Download the latest `mokoonyx-{version}.zip` from [Releases](https://git.mokoconsulting.tech/MokoConsulting/MokoOnyx/releases)
2. Install via Joomla's Extension Manager (Extensions > Manage > Install)
3. Set MokoOnyx as the default site template (System > Site Templates)
4. If migrating from MokoCassiopeia, settings are auto-migrated on install

### Requirements

- Joomla 5.x or 6.x
- PHP 8.1 or higher

---

## Directory Structure

| Directory | Purpose |
|-----------|---------|
| `html/` | Template overrides for core modules and extensions |
| `css/` | Compiled stylesheets including dark mode |
| `js/` | JavaScript for TOC, dark mode toggle, analytics |
| `images/` | Template images and icons |
| `language/` | Language files |

---

## Configuration

MokoOnyx template parameters are configured in the Joomla admin under System > Site Templates > MokoOnyx.

Key parameters include:
- **Dark Mode**: Enable/disable, set default mode
- **Font Awesome**: Enable/disable icon library loading
- **Google Tag Manager**: GTM container ID
- **GA4**: Measurement ID and tracking options
- **Table of Contents**: Auto-generate TOC for articles with heading threshold

---

## Related Wikis

| Repo | Purpose |
|------|---------|
| [Template-Client-WaaS](https://git.mokoconsulting.tech/MokoConsulting/Template-Client-WaaS/wiki) | Client site template (extends MokoOnyx) |
| [MokoWaaS](https://git.mokoconsulting.tech/MokoConsulting/MokoWaaS/wiki) | WaaS system plugin |
| [joomla-api-mcp](https://git.mokoconsulting.tech/MokoConsulting/joomla-api-mcp/wiki) | Joomla Web Services API MCP |
| [deploy-mcp](https://git.mokoconsulting.tech/MokoConsulting/deploy-mcp/wiki) | Git-based deployment MCP |

---

> **[MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki)** -- central standards hub for all Moko Consulting projects.

---



---

## Documentation

Full documentation is available on the [Wiki](https://git.mokoconsulting.tech/MokoConsulting/MokoOnyx/wiki).

## Contributing

See the wiki for development guidelines and contribution instructions.

## License

This project is licensed under the GNU General Public License v3.0 or later -- see the [LICENSE](LICENSE) file.

---

*[Moko Consulting](https://mokoconsulting.tech) -- [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*