@salla.sa/twilight-tailwind-theme 1.0.138 → 1.5.6

package/README.md

@@ -0,0 +1,40 @@
+## Usage 
+
+1. add the plugin to tailwaind plugins in `tailwind.config.js` file
+```js
+    plugins: [
+      ...
+      require('@salla.sa/twilight-tailwind-theme'),
+      ....
+    ]
+```
+
+### JIT Enabled
+
+**Tailwind** added a [just-in-time compiler](https://v2.tailwindcss.com/docs/just-in-time-mode), which generates styles as the developer writes the theme rather than generating everything in advance at initial build time.
+
+Since JIT mode generates your CSS on-demand by scanning your template files, it’s crucial that you configure the `content` option in your `tailwind.config.js` file with all of your template paths, otherwise your CSS will be empty
+
+
+```js title="tailwind.config.js"
+...
+  content: [
+    // theme views
+    "views/**/*.twig",
+    // list of classes which required by twilight web components
+    "node_modules/@salla.sa/twilight-tailwind-theme/safe-list-css.txt"
+  ],
+...
+```
+
+ ## Add A new compnoent 
+ 
+ 1. create a new folder with the name of compnenet
+ 2. create a `utilities.json` file with list of class as json
+
+
+## Publish 
+
+```
+npm run publish
+```

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@salla.sa/twilight-tailwind-theme",
-  "version": "1.0.138",
+  "version": "1.5.6",
   "license": "MIT",
   "keywords": [
+    "twilight",
     "Salla twilight",
     "tailwind",
     "tailwind-theme",
@@ -12,8 +13,9 @@
   "description": "Tailwind theme for twilight (Salla Themes)",
   "homepage": "https://salla.dev",
   "scripts": {
-    "generate": "node generator.js",
-    "push": "npm version patch && npm run generate && npm publish --access private"
+    "build": "node generator.js",
+    "watch": "run-when-changed --watch './../twilight-components/src/components/**/utilities.json' --exec 'npm run build' --verbose",
+    "push": "npm version patch && npm run build && npm publish --access private"
   },
   "files": [
     "index.js",
@@ -23,6 +25,8 @@
   ],
   "devDependencies": {
     "lodash": "^4.17.21",
+    "run-when-changed": "^2.1.0",
     "tailwindcss": "^2.2.19"
-  }
+  },
+  "gitHead": "e668115c17af905989367f1720c60085fc6baa08"
 }

package/readme.md

@@ -1,48 +0,0 @@
-## Usage 
-
-1. add the plugin to tailwaind plugins in `tailwind.config.js` file
-```js
-    plugins: [
-      ...
-      require('@salla.sa/twilight-tailwind-theme'),
-      ....
-    ]
-```
-2. (Optional) in case you are enabling the `purge` you should add the safe list css class to purge settings  in `tailwind.config.js` file
-
-### JIT Enabled 
-
-because of https://tailwindcss.com/docs/just-in-time-mode#limitations
-
-```js
-    mode: 'jit',
-    purge   : {
-      enabled: true,
-      content: ["views/**/*.twig", "node_modules/@salla.sa/twilight-tailwind-theme/safe-list-css.txt"]
-    }
-```
-
-### JIT Disabled
-
-You can easly add `/^s-.*/` to safelist
-```js
-    purge   : {
-        enabled: true,
-        content: ["views/**/*.twig"],
-        options: {
-            safelist: [/^s-.*/]
-        }
-    },
-```
-
- ## Add A new compnoent 
- 
- 1. create a new folder with the name of compnenet
- 2. create a `utilities.json` file with list of class as json
-
-
-## Publish 
-
-```
-npm run publish
-```