Inky-rb 开源项目教程

Inky-rb 开源项目教程

inky-rb项目地址:https://gitcode.com/gh_mirrors/in/inky-rb

项目介绍

Inky-rb 是一个基于 HTML 的模板语言，专门设计用于将简单的 HTML 转换为复杂的响应式电子邮件 HTML。它是为了与 ZURB 的响应式电子邮件框架 Foundation for Emails 配合使用而开发的。Inky-rb 通过扩展简单的 HTML 标签（如 <row> 和 <column>）为完整的表格语法，简化了创建 HTML 邮件的过程。

项目快速启动

安装

首先，确保你已经安装了 Ruby 和 Bundler。然后，在你的 Gemfile 中添加以下内容：

gem 'inky-rb'

接着运行：

bundle install

配置

在你的 Rails 应用中，创建一个初始化文件 config/initializers/inky.rb，并添加以下内容：

Inky.configure do |config|
  config.template_engine = :erb # 或者 :haml, :slim 等
end

使用

在你的视图文件中，使用 Inky 标签来编写 HTML：

<row>
  <columns large="6"></columns>
  <columns large="6"></columns>
</row>

Inky 会将其转换为复杂的响应式 HTML 代码。

应用案例和最佳实践

案例一：企业通讯邮件

Inky-rb 可以用于创建企业通讯邮件，确保在各种设备上都能良好显示。例如：

<container>
  <row>
    <columns large="12">
      <h1>企业通讯</h1>
    </columns>
  </row>
  <row>
    <columns large="6">
      <p>最新新闻</p>
    </columns>
    <columns large="6">
      <p>活动通知</p>
    </columns>
  </row>
</container>

最佳实践

1. 使用 CSS 内联工具：大多数电子邮件客户端忽略链接的样式表，建议使用 CSS 内联工具如 premailer-rails 或 roadie。
2. 测试多客户端兼容性：确保在多个电子邮件客户端（如 Outlook, Gmail, Apple Mail 等）中测试邮件的显示效果。

典型生态项目

Foundation for Emails

Inky-rb 是 Foundation for Emails 框架的一部分，该框架提供了一套完整的工具和模板，用于创建响应式电子邮件。

Nokogiri

Inky-rb 依赖于 Nokogiri 库，这是一个强大的 HTML 和 XML 解析器，用于处理和转换 HTML 代码。

Premailer-rails

Premailer-rails 是一个将外部 CSS 内联到 HTML 邮件中的工具，确保样式在所有电子邮件客户端中都能正确显示。

通过以上模块的介绍和实践，你可以快速上手并有效利用 Inky-rb 开源项目来创建复杂的响应式电子邮件。

inky-rb项目地址:https://gitcode.com/gh_mirrors/in/inky-rb