Remove client fork references from documentation
- Update README.md to remove client fork sections - Update CLAUDE.md to remove client fork file references - Update copilot-instructions.md to remove client fork section - Update templates/README.md for empty directory - Update scripts/README.md to remove create-client-fork.sh - Update docs/README.md to remove CLIENT_FORK_WORKFLOW.md references Co-authored-by: jmiller-moko <230051081+jmiller-moko@users.noreply.github.com>
This commit is contained in:
@@ -5,68 +5,25 @@
|
||||
BRIEF: Template files directory README
|
||||
-->
|
||||
|
||||
# MokoCassiopeia Template Files
|
||||
# MokoCassiopeia Templates Directory
|
||||
|
||||
This directory contains template files for client color customizations.
|
||||
This directory is reserved for future template files and customization resources.
|
||||
|
||||
---
|
||||
## Custom Color Palettes
|
||||
|
||||
## 📁 Available Templates
|
||||
For custom color schemes, you can create your own CSS files with custom CSS variables:
|
||||
|
||||
### Custom Color Scheme Template
|
||||
|
||||
**File**: `colors_custom.css`
|
||||
|
||||
A comprehensive template for creating custom color schemes. This template includes all CSS variables used by MokoCassiopeia for both light and dark modes.
|
||||
|
||||
**Usage**:
|
||||
1. Copy this file to either:
|
||||
- `src/media/css/colors/light/colors_custom.css` (for light mode)
|
||||
- `src/media/css/colors/dark/colors_custom.css` (for dark mode)
|
||||
2. Customize the CSS variables to match your brand colors
|
||||
3. Enable in Joomla: System → Site Templates → MokoCassiopeia → Theme tab
|
||||
4. Set the appropriate palette to "Custom"
|
||||
1. Create a new CSS file in `src/media/css/colors/light/` or `src/media/css/colors/dark/`
|
||||
2. Define CSS variables following the pattern in `colors_standard.css`
|
||||
3. Use Joomla's template settings (System → Site Templates → MokoCassiopeia → Custom Code tab) to load your custom CSS
|
||||
|
||||
**Reference**: See [CSS Variables Documentation](../docs/CSS_VARIABLES.md) for complete variable reference.
|
||||
|
||||
---
|
||||
|
||||
### Client Fork .gitignore Template
|
||||
|
||||
**File**: `gitignore-template`
|
||||
|
||||
A .gitignore template for client forks that ensures custom color files are tracked in the fork repository while maintaining proper ignore rules for other files.
|
||||
|
||||
**Usage**:
|
||||
- Automatically applied when using the client fork creation workflow
|
||||
- Can be manually copied to `.gitignore` in client fork repositories
|
||||
|
||||
---
|
||||
|
||||
## 🎯 When to Use These Templates
|
||||
|
||||
### Creating a Client Fork
|
||||
|
||||
If you're creating a custom fork of MokoCassiopeia for a specific client:
|
||||
|
||||
1. **Use the automated workflow**: See [CLIENT_FORK_WORKFLOW.md](../docs/CLIENT_FORK_WORKFLOW.md)
|
||||
2. **Set up custom colors**: Use `colors_custom.css` as your starting point
|
||||
3. **Test thoroughly**: Verify colors in both light and dark modes
|
||||
|
||||
### Custom Colors Only
|
||||
|
||||
If you just need custom colors without forking:
|
||||
|
||||
1. Use the `colors_custom.css` template
|
||||
2. Follow the instructions in the [main README](../README.md#custom-color-palettes)
|
||||
3. Enable custom palette in Joomla template settings
|
||||
|
||||
---
|
||||
|
||||
## 📚 Additional Resources
|
||||
|
||||
- **[Main README](../README.md)** - MokoCassiopeia features and installation
|
||||
- **[Client Fork Workflow](../docs/CLIENT_FORK_WORKFLOW.md)** - Automated fork setup guide
|
||||
- **[CSS Variables Reference](../docs/CSS_VARIABLES.md)** - All available CSS variables
|
||||
- **[Development Guide](../docs/JOOMLA_DEVELOPMENT.md)** - Development workflows
|
||||
|
||||
@@ -74,5 +31,4 @@ If you just need custom colors without forking:
|
||||
|
||||
**Template Directory**: `/templates/`
|
||||
**Version**: 03.08.04
|
||||
**Scope**: Colors only
|
||||
**Maintained by**: Moko Consulting
|
||||
|
||||
Reference in New Issue
Block a user