Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revamp docs #1141

Merged
merged 7 commits into from
Apr 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .changeset/big-worms-collect-2.md
Original file line number Diff line number Diff line change
Expand Up @@ -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';
Expand Down
4 changes: 2 additions & 2 deletions .changeset/big-worms-collect.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
4 changes: 2 additions & 2 deletions .changeset/small-apes-train.md
Original file line number Diff line number Diff line change
Expand Up @@ -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';
Expand Down
3 changes: 2 additions & 1 deletion .eslintrc.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@
"env": {
"node": true,
"mocha": true,
"es6": true
"es6": true,
"browser": true
},
"extends": ["eslint:recommended"],
"plugins": ["mocha"],
Expand Down
29 changes: 16 additions & 13 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Logs
logs
/logs
*.log
npm-debug.log*

Expand All @@ -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
Expand All @@ -24,7 +21,7 @@ coverage
.lock-wscript

# Compiled binary addons (http://nodejs.org/api/addons.html)
build/Release
/build/Release

# Dependency directories
node_modules
Expand All @@ -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
Expand All @@ -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/
10 changes: 5 additions & 5 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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';
Expand Down Expand Up @@ -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';
Expand Down
2 changes: 1 addition & 1 deletion __tests__/formats/lessIcons.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -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: {
Expand Down
2 changes: 1 addition & 1 deletion __tests__/formats/scssIcons.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -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: {
Expand Down
Empty file removed docs/.nojekyll
Empty file.
62 changes: 0 additions & 62 deletions docs/README.md

This file was deleted.

15 changes: 0 additions & 15 deletions docs/_coverpage.md

This file was deleted.

26 changes: 0 additions & 26 deletions docs/_sidebar.md

This file was deleted.

Loading
Loading