https://github.com/finchalyzer/slinky

Export your Sketch designs as HTML email templates
https://github.com/finchalyzer/slinky

email-template-generator sketch-app sketch-plugin

Last synced: 23 days ago
JSON representation

Export your Sketch designs as HTML email templates

• Host: GitHub
• URL: https://github.com/finchalyzer/slinky
• Owner: finchalyzer
• License: other
• Created: 2017-04-03T20:55:32.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-05-26T16:26:46.000Z (over 6 years ago)
• Last Synced: 2024-02-15T01:33:37.772Z (10 months ago)
• Topics: email-template-generator, sketch-app, sketch-plugin
• Language: TypeScript
• Size: 17.5 MB
• Stars: 601
• Watchers: 19
• Forks: 32
• Open Issues: 25
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Slinky 💎 ✉️

💾 [Download](https://github.com/finchalyzer/slinky/releases/download/v0.1.5/Slinky.zip) | 💎 [One-click Install via Sketchpacks](https://sketchpacks.com/finchalyzer/slinky/install) | 🐞 [Report an issue](https://github.com/finchalyzer/slinky/issues/new) | ⭐️ [Share love](https://github.com/finchalyzer/slinky/stargazers)

--- | --- | --- | ---

## Export your Sketch designs as HTML email templates

![Slinky demo](http://cdn.finch.io/public/slinky.gif)

Slinky is a [Sketch](https://www.sketchapp.com) plugin that allows you to export Sketch artboards as ready–to–send HTML e-mail templates.

### Installation

1. [Download](https://github.com/finchalyzer/slinky/archive/master.zip), unzip and double-click the **Slinky.sketchplugin** file and let Sketch automatically install the plugin for you

2. Open up your Sketch file and select the Artboard with your template design

3. Go to *Plugins -> Slinky -> Export Selected Artboard* from the Sketch top menu bar

4. Choose the folder where to export the template

5. Voilà!

We have prepared some *good to go* Sketch templates located in [templates](https://github.com/finchalyzer/slinky/templates) directory just for you 🎁

## Important Guidelines

Slinky is not perfect _yet_, so to get the best result, there are some things to remember creating you design file:

### ⚠️ Images and icons

Slinky will automatically export image and icon assets, but you need to individually mark them as **Exportable**

![](http://cdn.finch.io/public/slinky-exportable.gif)

### ⚠️ Links

Go to *Plugins -> Slinky -> Show/Hide Link URL* to show the Slinky link input in the inspector sidebar. Select the target layer and fill the *Link URL* field with the target link or e-mail.

For now this does not work for selected text *(help needed)*.

### ⚠️ Fonts

Slinky does not check the template for custom fonts *(yet)* and will export the template as it is. For the safest result across different email clients, we suggest you to use cross-platform fonts only:

- **Sans Serif Safe Fonts**

   - Arial

   - Arial Black

   - Century Gothic

   - Geneva

   - Lucida

   - Lucida Sans

   - Lucida Grande

   - Tahoma

   - Trebuchet MS

   - Verdana

- **Serif Safe Fonts**

   - Courier

   - Courier New

   - Georgia

   - MS Serif

   - Palatino

   - Palatino Linotype

   - Times

   - Times New Roman

## Feedback and support

Slinky is an early experiment by [Finch.io](https://finch.io) team and does only the basic stuff for now. We encourage you to help make Slinky more awesome by reporting issues and feature requests right here at github or via email at [[email protected]]([email protected]).