Skip to content

oscarmarcelo/sketch-theme-colors

Repository files navigation

Sketch Theme Colors

A quick way to see the colors used in Sketch's UI, made by Oscar Marcelo.

Build

This project is built in two phases:

  1. A Sketch plugin retrieves the necessary data from Sketch;
  2. The website is then built with the Sketch data.

Requirements

  • Sketch
  • Node.js

Instructions

  1. Just like any other Node project, run npm install;
  2. Ensure that in your Sketch Preferences > General, you have Appearance set to "System Default" and Canvas set to "Sketch Default".
  3. Run npm run get-colors to get Sketch data.
    1. If the terminal you are using isn't yet allowed to assistive access, the script will fail. Ensure it has permissions in System Preferences > Security & Privacy > Privacy tab > Accessibility option.
  4. Run npm start to build the website, run a local webserver and open the page.

Alternatively, you can run npm run build to just build the website without starting the webserver.

Contributing

I made this project as a side project to aid my work with the Sketch plugins I've been building on my spare time. Any contribution is very welcome!

These are some of the things I wish to work on next:

  • Improve design;
  • Improve code quality;
  • Automate repo updates through GitHub Actions;
    • Gather new data as soon as a new Sketch update releases;
  • Fix content not respecting search filter when one of the other filters changes;
  • Migrate to Node ESM when Gulp adds support for it:
  • Automate commits.