Revamp docs (#1141)

* feat: revamp docs

* chore: upgrade memfs

.changeset/big-worms-collect-2.md

@@ -2,7 +2,7 @@
 'style-dictionary': minor
 ---
 
-FileSystem that is used by Style-Dictionary can now be customized:
+FileSystem that is used by Style Dictionary can now be customized:
 
 ```js
 import { setFs } from 'style-dictionary/fs';

.changeset/big-worms-collect.md

@@ -3,8 +3,8 @@
 ---
 
 - The project has been fully converted to [ESM format](https://nodejs.org/api/esm.html), which is also the format that the browser uses.
-  For users, this means you'll have to either use Style-Dictionary in ESM JavaScript code, or dynamically import it into your CommonJS code.
-- `Style-Dictionary.extend()` method is now asynchronous, which means it returns `Promise<StyleDictionary.Core>` instead of `StyleDictionary.Core`.
+  For users, this means you'll have to either use Style Dictionary in ESM JavaScript code, or dynamically import it into your CommonJS code.
+- `StyleDictionary.extend()` method is now asynchronous, which means it returns `Promise<StyleDictionary.Core>` instead of `StyleDictionary.Core`.
 - `allProperties` / `properties` was deprecated in v3, and is now removed from `StyleDictionary.Core`, use `allTokens` and `tokens` instead.
 - Templates and the method `registerTemplate` were deprecated in v3, now removed. Use Formats instead.
 - The package now uses [package entrypoints](https://nodejs.org/api/packages.html), which means that what is importable from the package is locked down to just the specified entrypoints: `style-dictionary` & `style-dictionary/fs`. If more is needed, please raise an issue explaining which file you were importing and why you need it to be public API.

.changeset/small-apes-train.md

@@ -2,8 +2,8 @@
 'style-dictionary': minor
 ---
 
-Allow passing a custom FileSystem Volume to your Style-Dictionary instances, to ensure input/output files are read/written from/to that specific volume. 
-Useful in case you want multiple Style-Dictionary instances that are isolated from one another in terms of inputs/outputs.
+Allow passing a custom FileSystem Volume to your Style Dictionary instances, to ensure input/output files are read/written from/to that specific volume. 
+Useful in case you want multiple Style Dictionary instances that are isolated from one another in terms of inputs/outputs.
 
 ```js
 import { Volume } from 'memfs';

.eslintrc.json

@@ -6,7 +6,8 @@
   "env": {
     "node": true,
     "mocha": true,
-    "es6": true
+    "es6": true,
+    "browser": true
   },
   "extends": ["eslint:recommended"],
   "plugins": ["mocha"],

.gitignore

@@ -1,5 +1,5 @@
 # Logs
-logs
+/logs
 *.log
 npm-debug.log*
 
@@ -8,11 +8,8 @@ pids
 *.pid
 *.seed
 
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
 # Coverage directory used by tools like istanbul
-coverage
+/coverage
 
 # nyc test coverage
 .nyc_output
@@ -24,7 +21,7 @@ coverage
 .lock-wscript
 
 # Compiled binary addons (http://nodejs.org/api/addons.html)
-build/Release
+/build/Release
 
 # Dependency directories
 node_modules
@@ -40,24 +37,24 @@ yarn.lock
 .node_repl_history
 
 # Native Builds
-build/
+/build/
 
 # Android Specific Files
 .gradle/
 local.properties
-gen/
-out/
+/gen/
+/out/
 *.class
 .navigation/
-captures/
+/captures/
 *.apk
 *.ap_
 *.iml
 .idea/
 *.jks
 
 # IOS Specific Files
-DerivedData/
+/DerivedData/
 *.pbxuser
 !default.pbxuser
 *.mode1v3
@@ -77,5 +74,11 @@ xcuserdata/
 # Mac directory hidden files
 *.DS_Store
 
-# Temporary build output directory for unit tests
-__tests__/__output
+# Temporary build output directory for tests
+/__tests__/__output
+/__integration__/build
+
+# build output
+/docs/dist/
+# generated types
+.astro/

CHANGELOG.md

@@ -29,8 +29,8 @@
 
 ### Minor Changes
 
-- aff6646: Allow passing a custom FileSystem Volume to your Style-Dictionary instances, to ensure input/output files are read/written from/to that specific volume.
-  Useful in case you want multiple Style-Dictionary instances that are isolated from one another in terms of inputs/outputs.
+- aff6646: Allow passing a custom FileSystem Volume to your Style Dictionary instances, to ensure input/output files are read/written from/to that specific volume.
+  Useful in case you want multiple Style Dictionary instances that are isolated from one another in terms of inputs/outputs.
 
   ```js
   import { Volume } from 'memfs';
@@ -438,15 +438,15 @@
 
 - dcbe2fb:
   - The project has been fully converted to [ESM format](https://nodejs.org/api/esm.html), which is also the format that the browser uses.
-    For users, this means you'll have to either use Style-Dictionary in ESM JavaScript code, or dynamically import it into your CommonJS code.
-  - `Style-Dictionary.extend()` method is now asynchronous, which means it returns `Promise<StyleDictionary.Core>` instead of `StyleDictionary.Core`.
+    For users, this means you'll have to either use Style Dictionary in ESM JavaScript code, or dynamically import it into your CommonJS code.
+  - `StyleDictionary.extend()` method is now asynchronous, which means it returns `Promise<StyleDictionary.Core>` instead of `StyleDictionary.Core`.
   - `allProperties` / `properties` was deprecated in v3, and is now removed from `StyleDictionary.Core`, use `allTokens` and `tokens` instead.
   - Templates and the method `registerTemplate` were deprecated in v3, now removed. Use Formats instead.
   - The package now uses [package entrypoints](https://nodejs.org/api/packages.html), which means that what is importable from the package is locked down to just the specified entrypoints: `style-dictionary` & `style-dictionary/fs`. If more is needed, please raise an issue explaining which file you were importing and why you need it to be public API.
 
 ### Minor Changes
 
-- dcbe2fb: FileSystem that is used by Style-Dictionary can now be customized:
+- dcbe2fb: FileSystem that is used by Style Dictionary can now be customized:
 
   ```js
   import { setFs } from 'style-dictionary/fs';

__tests__/formats/lessIcons.test.js

@@ -45,7 +45,7 @@ const tokens = {
 };
 
 const platform = {
-  prefix: 'sd', // Style-Dictionary Prefix
+  prefix: 'sd', // Style Dictionary Prefix
   // FIXME: check why createFormatArgs requires this prefix to be wrapped inside
   // an options object for it to be properly set as option?
   options: {

__tests__/formats/scssIcons.test.js

@@ -46,7 +46,7 @@ const tokens = {
 };
 
 const platform = {
-  prefix: 'sd', // Style-Dictionary Prefix
+  prefix: 'sd', // Style Dictionary Prefix
   // FIXME: check why createFormatArgs requires this prefix to be wrapped inside
   // an options object for it to be properly set as option?
   options: {