From 4f2810091df0aaed8045ca6cc3beb5ebf7c6ec85 Mon Sep 17 00:00:00 2001 From: Fredrik Jonsson Date: Thu, 27 Mar 2025 15:39:27 +0100 Subject: [PATCH] Upgrade to 5.x instructions. --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2943fdf..ccee128 100644 --- a/README.md +++ b/README.md @@ -51,13 +51,20 @@ Quickstart a new site with the Zen theme by using the [Zen demo repo as a templa ## Version 5.x -* Rearanged a lot of variables so some work to upgrade if you have customisations. This is the reson for making this v5. +* Rearanged a lot of variables so some work to upgrade if you have customisations. This is the reson for making this v5. I'm working towards using vanilla css only. * Colours are now set directly as css variables. You no longer need to override `_colors.scss`, instead override select colours in `_custom.scss`. This simplification was the main motivation for v5. * Converted most sass settings in to pure css variables. * Split sass and css settings it to separate files. * The "respond-to" mixin is deprecated in v5, use css @media directly instead. +* jQuery/umbrella js is deprecated in v5, use alpinejs or vanilljs instead. * No other significant changes. +### Upgrade to 5.x + +1. Remove your projects `_colors.scss`, take note of the colours you have changed. +2. Override colours and other css variables in projects `_custom.scss`. +2. Update/remove/convert to css vars the variables you overridden in projects `_extra.scss` so they match changes in themes `_variables.scss` and `_sass_variables.scss`. + ## Version 4.x