Inkcite is the modular desin system for building modern, responsive email. Like Middleman is to static web sites, Inkcite enables #emailgeeks to use helpers (custom email components), variables, partials and conditionals to accelerate their email development workflow. Additionally, Inkcite provides easy ways to keep your code DRY (don’t repeat yourself) and to modernize email development using variables, versioning, testing, image optimization and code minification.
- Powerful media query and fluid-hybrid responsive support
- Custom, reusable email components and Helpers
- Easily define variables and use partials to make code reusable and emails consistent
- Support for conditionals and scripting for dynamic content, A/B Testing and 1-to-many personalization
- Automatic link tagging and tracking
- Automatic image optimization using ImageOptim
- Automatic email-safe HTML minification
- Instant compatibility testing with Litmus and other testing services
- Integration with ProofHQ for distributed, interactive group proofing
- Automatic Litmus Engagement analytics integration
- Email preview distribution lists
- Failsafe rules to automatically watch for errors and problems
Complete documentation for all of Inkcite's exciting features is available at http://inkcite.com
Inkcite is a Ruby gem. Ruby comes pre-installed on Mac OS X and Linux. If you’re using Windows, try RubyInstaller.
gem install inkcite
After Inkcite is installed, you will have access to the
Create a new Inkcite email at your terminal or command prompt:
inkcite init MY_EMAIL
This will create a new directory called
MY_EMAIL and fill it with the source
files for your new email project. It includes a subdirectory called
where your email components are stored and a subdirectory called
where you store all images for your email.
Change directories into your new project and start the preview server:
cd MY_EMAIL inkcite server
Inkcite’s preview server gives you a live view of your email as you build it
by modifying the
config.yml (or any partials
you create in this directory) or any files in the
Open your browser to
http://localhost:4567 to see your email as you build it.
As you make changes, your browser will automatically reload when changes are
made to any file in the project.
config.yml file has an extensive set of properties that influence the
HTML code that Inkcite produces plus how it sends preview emails.
During development, you can refer to your command prompt or terminal window to see important warnings (such as missing images or links).
If you have installed ImageOptim, you can enable automatic image optimization
config.yml file. Inkcite will ensure that every image in your project
is compressed using whatever settings you configure ImageOptim to use.
When you’re ready to see what your email looks like in an email client,
Inkcite will send previews on demand. Make sure you have configured the
smtp settings in the
config.yml file so that Inkcite can send email via
your SMTP server. When you’re ready to send:
With no other parameters, this will send a preview version of your email to
from email address you configured. You can also use the preview command
to send to your email to internal or client distribution lists for review.
Testing your Inkcite-built emails with Litmus is easy. Make sure you have
litmus section of the
The will create a new email test using your default set of email clients and send a preview version of the email to Litmus for testing. Subsequent runs of the test command will update the same test. Log into your Litmus account to review the results of the test.
After you’ve previewed and tested your email, you’re ready to create the production-ready email files. From the project directory:
By default, this will create the production version of your email. This includes fully-qualified URLs for images, link tracking and tagging and a host of other preflight features.
Documentation for Inkcite is available at http://inkcite.com
Github Issues is used for managing bug reports and feature requests. If you run into issues, please search the issues and submit new problems.
The best way to get quick responses to your issues and swift fixes to your bugs is to submit detailed bug reports, include test cases and respond to developer questions in a timely manner.
Copyright (c) 2014-2018 Jeffrey D. Hoffman. MIT Licensed, see LICENSE for details.