@runroom/design-tokens

Figma design tokens

Usage no npm install needed!

<script type="module">
  import runroomDesignTokens from 'https://cdn.skypack.dev/@runroom/design-tokens';
</script>

README

Design tokens

npm version node

test codecov

Originally inspired on: figma-tokens.

Installation

yarn add --dev @runroom/design-tokens

Usage

Config

Add a config file on the root directory of your project with the default name designtokens.config.json or design-tokens.config.json. If you chose to call it differently, specify a different config file while executing. You can find a template for your config file here

Execution

Add script to your package.json with the executable bin from node_modules.

"scripts": {
  "design-tokens": "design-tokens"
}

Then execute:

  • yarn design-tokens: If you want to sync with figma.
  • yarn design-tokens platforms: If you want to sync and compile assets.

You can specify a different config file name using the parameter --config-file=FILENAME. For example:

  • yarn design-tokens --config-file=myfile.json

License

License: MIT

This project is under the MIT license.