@visual-framework/vf-design-tokens/README.md

A collection of design tokens for consumption across projects and products

# Design tokens

[![npm version](https://badge.fury.io/js/%40visual-framework%2Fvf-design-tokens.svg)](https://badge.fury.io/js/%40visual-framework%2Fvf-design-tokens)

## About

[View the design token docs](https://stable.visual-framework.dev/design-tokens/)

## Usage

### Developing

1. `yarn install`
1. `gulp vf-tokens`
1. commit changes

## Install

This repository is distributed with [npm][https://www.npmjs.com/]. After [installing npm][https://www.npmjs.com/get-npm] and [yarn](https://classic.yarnpkg.com/en/docs/install), you can install `vf-design-tokens` with this command.

```
$ yarn add --dev @visual-framework/vf-design-tokens
```

### JS

This component does not use JS.

### Sass/CSS

The source files included are written in [Sass](http://sass-lang.com)(`scss`). You can point your Sass `include-path` at your `node_modules` directory and import it like this.

```
@import "@visual-framework/vf-design-tokens/index.scss";
```

Make sure you import Sass requirements along with the modules. You can use a [project boilerplate](https://stable.visual-framework.dev/building/) or the [`vf-sass-starter`](https://stable.visual-framework.dev/components/vf-sass-starter/)

## Help

- [Read the Visual Framework troubleshooting](https://stable.visual-framework.dev/troubleshooting/)
- [Open a ticket](https://github.com/visual-framework/vf-core/issues)
- [Chat on Slack](https://join.slack.com/t/visual-framework/shared_invite/enQtNDAxNzY0NDg4NTY0LWFhMjEwNGY3ZTk3NWYxNWVjOWQ1ZWE4YjViZmY1YjBkMDQxMTNlNjQ0N2ZiMTQ1ZTZiMGM4NjU5Y2E0MjM3ZGQ)