test-gy-design-tokens

Design Tokens

Tokens are a collection of JSON files that organize a brand's styles into a semantic hierarchy and enable generating multiple types of assets. Assets derived from these tokens can then be published as an npm package for others to use.

Installation

NPM

All brands are contained in a single package. See the Github Package Registry requirements for installing a package into your project.

npm install @publicissapient/design-tokens-starter

Use one of the following path structures for importing files:

@publicissapient/design-tokens-starter/<brand>/<file>
@publicissapient/design-tokens-starter/<brand>/<theme>/<file>

Usage

Each brand will contain the same files. Directory/file naming conventions use kebab-case.

• variables.css: CSS variables.
• variables.js: JavaScript variables.
• custom-media.css: Custom media query variables
• font-face.css: @font-face rules.
• utilities.css: A tiny set of utility classes based on the available tokens

Development

Development within this codebase requires experience with the following tools:

• Style Dictionary: Build system for design tokens.
• PostCSS: CSS transforming tool required by Tailwind CSS.
• Tailwind CSS: PostCSS plugin for creating the custom CSS utilities.
• Handlebars: HTML templating system used for documentation site.
• Semantic Release: Automates the version management and package publishing.
• GitHub Actions: GitHub's CI/CD automation tool.

For more info read the docs on adding new tokens and the development/release process.

Credits

• Example icons from https://github.com/mikolajdobrucki/ikonate.