Frzn/tokens
3
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
tokens/docs
History
NotAShelf 778205f9c2
 docs: link to Design Dictionary docs in README 
Signed-off-by: NotAShelf <raf@notashelf.dev>
Change-Id: I0d2a77a9bb811c3265708367d3cf61146a6a6964
2026-05-02 19:59:15 +03:00
..
assets docs: add project README; provide preview example 2026-05-02 19:56:50 +03:00
README.md docs: link to Design Dictionary docs in README 2026-05-02 19:59:15 +03:00

README.md

@frozendev/tokens

Single source of truth for FrozenDev color system. You may use the sources in tokens/ and run pnpm run build to generate outputs. Every platform gets an up-to-date file. No manual syncing.

Powered by Design Dictionary. Please see the documentation for additional configuration options and usage details.

Editing tokens

All changes start in tokens/:

  • New colour stop -> add to tokens/color.json
  • Semantic role change-> edit tokens/semantic.json
  • Never edit anything in outputs/ directly. It will be overwritten on the next build

After editing:

# Execute the build script in scripts/build.mjs
$ pnpm run build   # regenerates all outputs

Commit both tokens/ and outputs/ so the CDN/raw GitHub URL paths keep working.

Local development

# This repository is designed to work with pnpm. Prefer it over npm or yarn.
$ pnpm install
$ pnpm run build

Outputs land in outputs/.

Previewing Colors

A preview script is provided in scripts/preview.mjs that you can invoke with pnpm preview. It will generate a HTML page in build/ that you can open with your browser to preview the colors before publishing any packages.