swatchkit 0.8.0 → 0.8.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 +5 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -38,7 +38,10 @@ my-project/
|
|
|
38
38
|
│ └── ...
|
|
39
39
|
└── dist/
|
|
40
40
|
└── swatchkit/ # Built pattern library
|
|
41
|
-
|
|
41
|
+
├── index.html
|
|
42
|
+
├── js/
|
|
43
|
+
│ └── swatches.js # Bundled swatch scripts
|
|
44
|
+
└── preview/ # Full-screen preview pages
|
|
42
45
|
```
|
|
43
46
|
|
|
44
47
|
---
|
|
@@ -220,6 +223,7 @@ Compiles your documentation site into `dist/swatchkit/`.
|
|
|
220
223
|
2. **Generates CSS**: Creates `css/tokens.css`. **Do not edit this file**; it is overwritten every build.
|
|
221
224
|
3. **Copies Assets**: Copies your `css/` folder (including your manually edited `global-styles.css` and `main.css`) to the output folder.
|
|
222
225
|
4. **Scans Patterns**: Finds all HTML files in `swatchkit/` and stitches them into the documentation site.
|
|
226
|
+
5. **Bundles JavaScript**: Collects any `.js` files from swatch folders (e.g., `swatchkit/carousel/script.js`) and section directories into a single `js/swatches.js` bundle. The default token display script (`swatchkit/tokens/script.js`) is included here — it shows computed CSS values alongside token documentation.
|
|
223
227
|
|
|
224
228
|
### Global Styles & Variables
|
|
225
229
|
SwatchKit includes sensible defaults in `css/variables.css` and `css/global-styles.css`.
|