README.md

Hubble Sketch Plugin

Sketch Plugin to couple your Sketch file to the Hubble Design System.

Takes your design data out of Sketch and connects it to the Hubble atmosphere.

Contents

• Prerequisites
• Installing
• Usage
• Contributing
• License

Prerequisites

• macOS with Sketch 41+ (latest Sketch recommended)
• Hubble.app installed

Installing

The easiest way to install is to download one of the releases and install the plugin in Sketch. Once installed the plugin can be automatically updated through the Sketch Plugin Manager.

👉 Download the latest release

hubble-sketch-plugin can also be installed using Sketch Runner:

Usage

After the installation, the 🔭 Hubble plugin will be available in your plugin list. You should first configure your document and enter a unique identifier for your project.

This will store the identifier for this project in the Sketch file directly. After this you can start exporting your data to Hubble.app!

Check out the detailed documentation for more info on how to use hubble-sketch-plugin together with the Hubble ecosystem.

Contributing

❤ We appreciate every form of contribution, but before you contribute please make sure you have read the contribution guidelines

Development

This plugin was created using skpm. For a detailed explanation on how things work, checkout the skpm Readme. Uses the Sketch JS API for grabbing certain properties

Install the dependencies

npm install

Once the installation is done, you can run some commands inside the project folder:

npm run build

To watch for changes:

npm run watch

Additionally, if you wish to run the plugin every time it is built:

npm run start

For more on running in development mode, check the wiki

License

MIT