55 lines
2.7 KiB
Markdown
55 lines
2.7 KiB
Markdown
<!-- Copyright (C) 2026 Moko Consulting <hello@mokoconsulting.tech>
|
|
|
|
This file is part of a Moko Consulting project.
|
|
|
|
SPDX-License-Identifier: GPL-3.0-or-later
|
|
|
|
# FILE INFORMATION
|
|
DEFGROUP: Joomla.Template.Site
|
|
INGROUP: MokoOnyx.Documentation
|
|
REPO: https://git.mokoconsulting.tech/MokoConsulting/MokoOnyx
|
|
FILE: ./README.md
|
|
VERSION: 01.00.26
|
|
BRIEF: Documentation for MokoOnyx template
|
|
-->
|
|
|
|
# MokoOnyx
|
|
|
|
> **MokoOnyx** is the successor to MokoCassiopeia. On install, it automatically migrates your settings, content references, and custom files. After installing, MokoCassiopeia can be safely uninstalled.
|
|
|
|
**A Modern, Lightweight Joomla Template Based on Cassiopeia**
|
|
|
|
[](https://git.mokoconsulting.tech/MokoConsulting/MokoOnyx/releases/tag/stable)
|
|
[](LICENSE)
|
|
[](https://www.joomla.org)
|
|
[](https://www.php.net)
|
|
|
|
MokoOnyx is a modern, lightweight enhancement layer built on top of Joomla's Cassiopeia template. It adds **Font Awesome 7**, **Bootstrap 5** helpers, an automatic **Table of Contents (TOC)** utility, advanced **Dark Mode** theming, and optional integrations for **Google Tag Manager** and **Google Analytics (GA4)** -- all while maintaining minimal core template overrides for maximum upgrade compatibility.
|
|
|
|
## Features
|
|
|
|
- **Built on Cassiopeia**: Extends Joomla's default template with minimal overrides
|
|
- **Font Awesome 7**: Fully integrated into Joomla's asset manager with 2,000+ icons
|
|
- **Bootstrap 5**: Extended utility classes and responsive grid system
|
|
- **Template Overrides**: Includes overrides for all core Joomla modules, Community Builder, and DPCalendar
|
|
- **Dark Mode Support**: Built-in light/dark mode toggle with system preference detection
|
|
- **Google Tag Manager / GA4**: Optional analytics integrations
|
|
- **Table of Contents**: Automatic TOC generation for long articles
|
|
|
|
## Requirements
|
|
|
|
- **Joomla**: 5.x or 6.x
|
|
- **PHP**: 8.1 or higher
|
|
|
|
## Installation
|
|
|
|
Download the latest `mokoonyx-{version}.zip` from [Releases](https://git.mokoconsulting.tech/MokoConsulting/MokoOnyx/releases) and install via Joomla's Extension Manager.
|
|
|
|
## License
|
|
|
|
This project is licensed under the **GNU General Public License v3.0** - see the [LICENSE](./LICENSE) file for details.
|
|
|
|
---
|
|
|
|
**Made with love by [Moko Consulting](https://mokoconsulting.tech)**
|