From: Zoran Date: Fri, 1 Jul 2016 18:38:54 +0000 (-0700) Subject: fix description frontmatter in docs X-Git-Tag: v2.3.0~38^2~1^2 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F498%2Fhead;p=thirdparty%2Ffoundation%2Ffoundation-emails.git fix description frontmatter in docs --- diff --git a/docs/pages/gem-guide.md b/docs/pages/gem-guide.md index 51d426f4..314fe409 100644 --- a/docs/pages/gem-guide.md +++ b/docs/pages/gem-guide.md @@ -1,13 +1,13 @@ --- title: Getting Started with the Ruby Gem -description: **inky-rb** is a gem that allows you to bring the power of Foundation for Emails into your Rails apps. It can be embedded into the Asset Pipeline, combining with a CSS inliner to let you generate awesomely responsive HTML emails that work across various clients. +description: inky-rb is a gem that allows you to bring the power of Foundation for Emails into your Rails apps. It can be embedded into the Asset Pipeline, combining with a CSS inliner to let you generate awesomely responsive HTML emails that work across various clients. --- ## How It Works ![inky_gem_diagram.png](../assets/img/inky_gem_diagram.png) -inky-rb is a pure Ruby implementation of the Inky templating language that converts simple custom HTML tags like `` and `` into the complex table-based HTML required for emails. +**inky-rb** is a pure Ruby implementation of the Inky templating language that converts simple custom HTML tags like `` and `` into the complex table-based HTML required for emails. Using a CSS inliner like `premailer-rails` or `roadie`, you're able to keep your email templates lean by avoiding the need to manually embed styles in the markup. By parsing your email template, the inliner is able to locate your referenced stylesheet and go through all of the selectors specified within it, assigning the styles to matching elements within the document. @@ -73,6 +73,8 @@ Finally, your mailer layout should have the following structure: Done! You're now all set to start writing responsive emails in your Rails app. +--- + ## Standalone Assets To include only the Foundation for Emails styles in your Asset Pipeline, without the Inky templating language, use the [**foundation_emails**](https://github.com/zurb/foundation-emails/#using-the-ruby-gem) gem.