zeus-css 1.0.2 → 1.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +2 -4
- package/README.md +12 -6
- package/package.json +2 -1
package/CHANGELOG.md
CHANGED
|
@@ -6,10 +6,8 @@ documented in [`API.md`](API.md).
|
|
|
6
6
|
|
|
7
7
|
## [Unreleased]
|
|
8
8
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
public API surface; semver will become binding once `1.0.0` is actually
|
|
12
|
-
published, not before.
|
|
9
|
+
Published to npm as `zeus-css`. [`API.md`](API.md) documents the public API
|
|
10
|
+
surface this changelog's semver contract is now binding against.
|
|
13
11
|
|
|
14
12
|
### Removed (since first written)
|
|
15
13
|
- **Dark mode**, entirely — `$zeus-dark-mode-strategy` and
|
package/README.md
CHANGED
|
@@ -18,29 +18,33 @@ import 'zeus-css/dist/zeus.css';
|
|
|
18
18
|
```
|
|
19
19
|
|
|
20
20
|
### 2. Configure Your Custom Theme (Optional)
|
|
21
|
-
Generate the configuration
|
|
21
|
+
Generate the configuration files by running the init command in your project root:
|
|
22
22
|
|
|
23
23
|
```bash
|
|
24
24
|
npx zeus-css init
|
|
25
25
|
```
|
|
26
26
|
|
|
27
|
-
This
|
|
27
|
+
This creates three files: `zeus.config.scss` (structural settings — breakpoints, feature toggles), `zeus.customize.scss` (design tokens — colors, spacing, typography), and a generated `zeus.scss` bridge that wires your overrides into the framework. Override colors and other tokens in `zeus.customize.scss`, using OKLCH:
|
|
28
28
|
|
|
29
29
|
```scss
|
|
30
|
-
// zeus.
|
|
30
|
+
// zeus.customize.scss
|
|
31
31
|
$zeus-colors: (
|
|
32
32
|
"primary": oklch(57.9% 0.232 259.6),
|
|
33
33
|
"secondary": oklch(74.7% 0.174 60.6)
|
|
34
34
|
) !default;
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
Then import your local bridge instead of the package directly:
|
|
35
38
|
|
|
36
|
-
|
|
39
|
+
```scss
|
|
40
|
+
@use "./zeus.scss" as *;
|
|
37
41
|
```
|
|
38
42
|
|
|
39
43
|
### 3. Use CSS Variables in CSS Modules
|
|
40
|
-
Thanks to the framework's token generation, you can natively use the fluid CSS variables everywhere:
|
|
44
|
+
Thanks to the framework's token generation, you can natively use the fluid CSS variables everywhere. If you ran `zeus-css init` (step 2), import your local bridge (`./zeus.scss`); otherwise import the package directly:
|
|
41
45
|
|
|
42
46
|
```scss
|
|
43
|
-
@use "zeus-css/scss/zeus.scss" as *;
|
|
47
|
+
@use "zeus-css/scss/zeus.scss" as *; // or "./zeus.scss" if you ran init
|
|
44
48
|
|
|
45
49
|
.card {
|
|
46
50
|
padding: var(--space-md) var(--space-lg);
|
|
@@ -54,6 +58,8 @@ Thanks to the framework's token generation, you can natively use the fluid CSS v
|
|
|
54
58
|
}
|
|
55
59
|
```
|
|
56
60
|
|
|
61
|
+
> **Note:** Bundlers (Next.js, Vite, webpack `sass-loader`) resolve `zeus-css/...` imports automatically. Compiling with the plain `sass` CLI instead requires `--load-path=node_modules`.
|
|
62
|
+
|
|
57
63
|
## ⚠️ Optimizing for Production (Crucial)
|
|
58
64
|
Zeus CSS ships with thousands of utility classes to give you absolute freedom during development. For production builds, you **must** use PurgeCSS to remove unused selectors and keep your CSS payload tiny.
|
|
59
65
|
|
package/package.json
CHANGED
|
@@ -1,9 +1,10 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "zeus-css",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.3",
|
|
4
4
|
"description": "⚡ A Premium, Zero-Emission, Fluid-Scaling CSS Framework based on Sass SCSS Engine",
|
|
5
5
|
"author": "Stavros Lazaris",
|
|
6
6
|
"license": "MIT",
|
|
7
|
+
"homepage": "https://www.npmjs.com/package/zeus-css",
|
|
7
8
|
"main": "./dist/zeus.css",
|
|
8
9
|
"style": "./dist/zeus.css",
|
|
9
10
|
"bin": {
|