@davincihealthcare/elty-design-system-vue 1.11.0 → 1.11.1
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/README.md +4 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -94,17 +94,17 @@ As it has been set the following as `peer dependencies`
|
|
|
94
94
|
|
|
95
95
|
This section handles the styling for your Vue component library, leveraging Tailwind CSS for efficiency. Here's a breakdown of the process:
|
|
96
96
|
|
|
97
|
-
1. Base Styles (src/style.css):
|
|
97
|
+
1. Base Styles (`src/style.css`):
|
|
98
98
|
|
|
99
99
|
This file is where you define the foundational CSS styles that you want to use in conjunction with Tailwind. Focus on including essential styles that are unlikely to change frequently. This helps maintain a clean separation between your core design principles and the dynamic nature of Tailwind classes.
|
|
100
100
|
|
|
101
|
-
2. Tailwind Processing (yarn build):
|
|
101
|
+
2. Tailwind Processing (`yarn build`):
|
|
102
102
|
Running yarn build triggers postcss, a CSS preprocessor. It scans src/style.css and replaces Tailwind directives (@apply, etc.) with actual CSS classes based on your Tailwind configuration. The processed output is saved as dist/style.css.
|
|
103
103
|
|
|
104
|
-
3. CJS Conversion (yarn build-prejss):
|
|
104
|
+
3. CJS Conversion (`yarn build-prejss`):
|
|
105
105
|
A separate script (potentially yarn build-prejss) is called during yarn build. It takes the processed CSS file (dist/style.css) and generates a CommonJS module (dist/style.cjs). This format is necessary because your src/tailwind.plugin.ts file will import it (explained below).
|
|
106
106
|
|
|
107
|
-
4. Tailwind Integration (src/tailwind.plugin.ts):
|
|
107
|
+
4. Tailwind Integration (`src/tailwind.plugin.ts`):
|
|
108
108
|
This file defines the Tailwind plugin used within your library. It imports the generated dist/style.cjs file. When you integrate your library into another project that has Tailwind installed, this import will work seamlessly because the library will include the compiled style.cjs file.
|
|
109
109
|
|
|
110
110
|
Key Points:
|