{"_id":"542979c51215fe08007e0eeb","createdAt":"2014-09-29T15:24:53.564Z","githubsync":"","is_link":false,"order":0,"parentDoc":null,"__v":24,"category":"542979c51215fe08007e0ee9","link_external":false,"link_url":"","title":"Getting Started","type":"basic","api":{"results":{"codes":[]},"settings":"","try":true,"url":"","auth":"never","basic_auth":false,"params":[]},"excerpt":"This page will help you get started with Inkcite. You'll be up and running in a jiffy!","hidden":false,"project":"542979c51215fe08007e0ee5","slug":"getting-started","updates":[],"version":"542979c51215fe08007e0ee8","body":"Inkcite is an opinionated workflow for building modern, responsive email. Inkcite makes it easy for email developers to keep their code DRY (don’t repeat yourself) and integrate versioning, testing and minification into their workflow.\n\n* Easy, flexible templates, variables and [Helpers](doc:helpers) \n* ERB for dynamic content and easy [A/B Testing and Versioning](doc:ab-testing-and-versioning) \n* Automatic [link tagging and tracking](doc:links)\n* Instant [compatibility testing](doc:compatibility-testing) with Email on Acid or Litmus\n* Litmus [Engagement analytics](doc:litmus-analytics) integration\n* [Email previews](doc:email-previews) \n* Automatic [image optimization](doc:image-optimization) using ImageOptim\n* [Failsafe rules](doc:failsafes) to double-check your work\n\n# Installation\n\nInkcite is a Ruby gem.  Ruby comes pre-installed on Mac OS X and Linux.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"gem install inkcite\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Ruby on Windows\",\n  \"body\": \"If you’re using Windows, try [RubyInstaller](http://rubyinstaller.org).\"\n}\n[/block]\n# Creating a New Project\n\nOnce Inkcite is installed, you will have access to the `inkcite` command.  Create a new Inkcite email at your terminal or command prompt:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"inkcite init MY_EMAIL\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]\nThis will create a new sub-directory called `MY_EMAIL` and fill it with the source files for your new email project:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"file\",\n    \"h-1\": \"purpose\",\n    \"0-0\": \"`config.yml`\",\n    \"0-1\": \"Project configuration settings that influence the HTML Inkcite produces and how it sends previews of your email.\",\n    \"1-0\": \"`helpers.tsv`\",\n    \"1-1\": \"Tab-delimited variable and helper definitions\",\n    \"2-0\": \"`source.html`\",\n    \"3-0\": \"`source.txt`\",\n    \"3-1\": \"The text-only version of your email, if desired.\",\n    \"2-1\": \"The HTML body content for your email. Use helpers and ERB here.\",\n    \"4-0\": \"`images/`\",\n    \"4-1\": \"All images in your email go into this sub-directory.\"\n  },\n  \"cols\": 2,\n  \"rows\": 5\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Clone an Existing Inkcite Project\",\n  \"body\": \"To clone an existing Inkcite email into a new project, you can use `inkcite init new_project --from old_project`.  This will copy the source files and all of the images into the new destination project.\"\n}\n[/block]\n# Start the Preview Server\n\nInkcite’s preview server gives you a live view of your email as you build it by modifying the `source.html`, `source.txt`, `helpers.tsv` and `config.yml` files.   Change directories into your new project and start the server:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"cd MY_EMAIL\\ninkcite server\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]\nOpen your browser to `http://localhost:4567` to see your email as you build it.  As you make changes to `source.html`, `helpers.tsv`, images or the other files in the project, your browser will automatically refresh to show the latest version.\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Note!\",\n  \"body\": \"Inkcite's preview server provides a reasonable approximation of how your email will render in many modern email clients.  Before you send, always test using Inkcite's built-in email previews and Litmus compatibility testing.\"\n}\n[/block]\nDuring development, you can refer to your command prompt or terminal window to see important warnings (such as missing images or links).\n\n# Tutorial\n\nA comprehensive tutorial on building a modern, responsive email using the Fluid-Hybrid method is [available on the Inkceptional blog](http://blog.inkceptional.com/build-a-modern-responsive-email-with-inkcite/).","sync_unique":"","user":"542979b61215fe08007e0ee4","childrenPages":[]}

Getting Started

This page will help you get started with Inkcite. You'll be up and running in a jiffy!

Inkcite is an opinionated workflow for building modern, responsive email. Inkcite makes it easy for email developers to keep their code DRY (don’t repeat yourself) and integrate versioning, testing and minification into their workflow. * Easy, flexible templates, variables and [Helpers](doc:helpers) * ERB for dynamic content and easy [A/B Testing and Versioning](doc:ab-testing-and-versioning) * Automatic [link tagging and tracking](doc:links) * Instant [compatibility testing](doc:compatibility-testing) with Email on Acid or Litmus * Litmus [Engagement analytics](doc:litmus-analytics) integration * [Email previews](doc:email-previews) * Automatic [image optimization](doc:image-optimization) using ImageOptim * [Failsafe rules](doc:failsafes) to double-check your work # Installation Inkcite is a Ruby gem. Ruby comes pre-installed on Mac OS X and Linux. [block:code] { "codes": [ { "code": "gem install inkcite", "language": "shell" } ] } [/block] [block:callout] { "type": "info", "title": "Ruby on Windows", "body": "If you’re using Windows, try [RubyInstaller](http://rubyinstaller.org)." } [/block] # Creating a New Project Once Inkcite is installed, you will have access to the `inkcite` command. Create a new Inkcite email at your terminal or command prompt: [block:code] { "codes": [ { "code": "inkcite init MY_EMAIL", "language": "shell" } ] } [/block] This will create a new sub-directory called `MY_EMAIL` and fill it with the source files for your new email project: [block:parameters] { "data": { "h-0": "file", "h-1": "purpose", "0-0": "`config.yml`", "0-1": "Project configuration settings that influence the HTML Inkcite produces and how it sends previews of your email.", "1-0": "`helpers.tsv`", "1-1": "Tab-delimited variable and helper definitions", "2-0": "`source.html`", "3-0": "`source.txt`", "3-1": "The text-only version of your email, if desired.", "2-1": "The HTML body content for your email. Use helpers and ERB here.", "4-0": "`images/`", "4-1": "All images in your email go into this sub-directory." }, "cols": 2, "rows": 5 } [/block] [block:callout] { "type": "info", "title": "Clone an Existing Inkcite Project", "body": "To clone an existing Inkcite email into a new project, you can use `inkcite init new_project --from old_project`. This will copy the source files and all of the images into the new destination project." } [/block] # Start the Preview Server Inkcite’s preview server gives you a live view of your email as you build it by modifying the `source.html`, `source.txt`, `helpers.tsv` and `config.yml` files. Change directories into your new project and start the server: [block:code] { "codes": [ { "code": "cd MY_EMAIL\ninkcite server", "language": "shell" } ] } [/block] Open your browser to `http://localhost:4567` to see your email as you build it. As you make changes to `source.html`, `helpers.tsv`, images or the other files in the project, your browser will automatically refresh to show the latest version. [block:callout] { "type": "warning", "title": "Note!", "body": "Inkcite's preview server provides a reasonable approximation of how your email will render in many modern email clients. Before you send, always test using Inkcite's built-in email previews and Litmus compatibility testing." } [/block] During development, you can refer to your command prompt or terminal window to see important warnings (such as missing images or links). # Tutorial A comprehensive tutorial on building a modern, responsive email using the Fluid-Hybrid method is [available on the Inkceptional blog](http://blog.inkceptional.com/build-a-modern-responsive-email-with-inkcite/).