MokoConsulting/MokoCassiopeia
1
1
Fork 0
Code Issues 2 Pull Requests Actions Packages Releases 1 Activity

Update README.md

Browse Source
This commit is contained in:
Jonathan Miller
2025-12-11 10:59:16 -06:00
parent 56a74c3ab3
commit f0f536be2c
1 changed files with 30 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
README.md
View File

@@ -32,35 +32,35 @@ upgrade-friendly.
## Table of Contents ## Table of Contents
- [Features](#features)\ - [Features](#features)
- [Requirements](#requirements)\ - [Requirements](#requirements)
- [Quick Start](#quick-start)\ - [Quick Start](#quick-start)
- [Installation](#installation)\ - [Installation](#installation)
- [Configuration](#configuration) - [Configuration](#configuration)
- [Global Params](#global-params)\ - [Global Params](#global-params)
- [Font Awesome 6](#font-awesome-6)\ - [Font Awesome 6](#font-awesome-6)
- [Bootstrap 5 Helpers](#bootstrap-5-helpers)\ - [Bootstrap 5 Helpers](#bootstrap-5-helpers)
- [Table of Contents](#table-of-contents)\ - [Table of Contents](#table-of-contents)
- [Dark Mode Toggle](#dark-mode-toggle)\ - [Dark Mode Toggle](#dark-mode-toggle)
- [Soft Offline Mode](#soft-offline-mode)\ - [Soft Offline Mode](#soft-offline-mode)
- [Changelog](#changelog)\ - [Changelog](#changelog)
- [Roadmap](#roadmap) - [Roadmap](#roadmap)
## Features ## Features
### Core Enhancements ### Core Enhancements
- Built on top of Joomla's default **Cassiopeia** template.\ - Built on top of Joomla's default **Cassiopeia** template.
- **Font Awesome 6** integration.\ - **Font Awesome 6** integration.
- **Bootstrap 5** helpers (grid, utility classes).\ - **Bootstrap 5** helpers (grid, utility classes).
- **Automatic TOC** insertion for articles (activated via layout - **Automatic TOC** insertion for articles (activated via layout
`toc-left` or `toc-right`). `toc-left` or `toc-right`).
### Added in 2.0 ### Added in 2.0
- **Dark Mode Toggle** - **Dark Mode Toggle**
- User-facing switch in the header.\ - User-facing switch in the header.
- Persists preference with local storage.\ - Persists preference with local storage.
- Admins can override default mode in template settings. - Admins can override default mode in template settings.
- **Improved Template Params** - **Improved Template Params**
- Configure logo, GTM container ID, and dark mode defaults - Configure logo, GTM container ID, and dark mode defaults
@@ -70,27 +70,27 @@ upgrade-friendly.
- **Soft Offline Mode** - **Soft Offline Mode**
- Keeps articles in specific categories available when the site is - Keeps articles in specific categories available when the site is
offline.\ offline.
- Example: legal or policy documents remain publicly viewable even - Example: legal or policy documents remain publicly viewable even
during maintenance.\ during maintenance.
- Admin can configure which categories remain accessible. - Admin can configure which categories remain accessible.
## Requirements ## Requirements
- Joomla **4.4.x** or **5.x**\ - Joomla **4.4.x** or **5.x**
- PHP **8.0+**\ - PHP **8.0+**
- MySQL/MariaDB compatible database - MySQL/MariaDB compatible database
## Quick Start ## Quick Start
1. Install `moko-cassiopeia.zip` via Joomla's Template Installer.\ 1. Install `moko-cassiopeia.zip` via Joomla's Template Installer.
2. Set **Moko-Cassiopeia** as your default template.\ 2. Set **Moko-Cassiopeia** as your default template.
3. Configure template options under **System → Site Templates → 3. Configure template options under **System → Site Templates →
Moko-Cassiopeia**. Moko-Cassiopeia**.
## Installation ## Installation
Upload and install through Joomla's extension manager.\ Upload and install through Joomla's extension manager.
If upgrading from a prior version, Joomla will safely overwrite files If upgrading from a prior version, Joomla will safely overwrite files
--- no manual uninstall required. --- no manual uninstall required.
@@ -98,13 +98,13 @@ If upgrading from a prior version, Joomla will safely overwrite files
### Global Params ### Global Params
- **Logo**: Upload a custom site logo.\ - **Logo**: Upload a custom site logo.
- **Color Scheme**: Toggle light/dark defaults.\ - **Color Scheme**: Toggle light/dark defaults.
- **Analytics/GTM**: Enable/disable optional expansions. - **Analytics/GTM**: Enable/disable optional expansions.
### Font Awesome 7 ### Font Awesome 7
- Fully integrated into Joomla's asset manager.\ - Fully integrated into Joomla's asset manager.
- No extra scripts required. - No extra scripts required.
### Bootstrap 5 Helpers ### Bootstrap 5 Helpers
@@ -118,15 +118,15 @@ If upgrading from a prior version, Joomla will safely overwrite files
### Dark Mode Toggle ### Dark Mode Toggle
- User-facing switch in the header.\ - User-facing switch in the header.
- Remembers preference via local storage.\ - Remembers preference via local storage.
- Default behavior can be set in template settings. - Default behavior can be set in template settings.
### Soft Offline Mode ### Soft Offline Mode
- Introduced in **2.1.5**.\ - Introduced in **2.1.5**.
- Allows articles in selected categories to remain viewable during - Allows articles in selected categories to remain viewable during
offline/maintenance mode.\ offline/maintenance mode.
- Useful for compliance, legal, or policy content. - Useful for compliance, legal, or policy content.
## Changelog ## Changelog