inky-rb 0.0.3 → 1.3.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile.lock +4 -4
- data/README.md +23 -12
- data/lib/inky/rails/version.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 3282f169829c4857894a4cb75b7ef6a5a96f3edc
|
4
|
+
data.tar.gz: 3bceb0ddb23bad1075e79ef58bad6040dbf7e17f
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: a1ae7a6c393a72b2aa6c4a3f7d4ca463253a95f2b826f6a4e5032c2454efc4e1044d4e9bc25ca126eb618e4eb34c5024e92e2f3a0844f87af1c7846cc714ef83
|
7
|
+
data.tar.gz: 28240f7c706c4a3fa1dcc294f45a3c6f4f0e2d929780f7419fa5715c3e69a31f589e396c026a77947e21254f193e9a217cf144cf2a2262cfe37c0725c4e07fce
|
data/Gemfile.lock
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
PATH
|
2
2
|
remote: .
|
3
3
|
specs:
|
4
|
-
inky-rb (0.0.
|
4
|
+
inky-rb (0.0.3)
|
5
5
|
foundation_emails (~> 2)
|
6
6
|
|
7
7
|
GEM
|
@@ -9,8 +9,8 @@ GEM
|
|
9
9
|
specs:
|
10
10
|
diff-lcs (1.2.5)
|
11
11
|
foundation_emails (2.1.0.1)
|
12
|
-
rake (11.
|
13
|
-
rspec-core (3.4.
|
12
|
+
rake (11.2.2)
|
13
|
+
rspec-core (3.4.4)
|
14
14
|
rspec-support (~> 3.4.0)
|
15
15
|
rspec-expectations (3.4.0)
|
16
16
|
diff-lcs (>= 1.2.0, < 2.0)
|
@@ -28,4 +28,4 @@ DEPENDENCIES
|
|
28
28
|
rspec-expectations
|
29
29
|
|
30
30
|
BUNDLED WITH
|
31
|
-
1.
|
31
|
+
1.12.4
|
data/README.md
CHANGED
@@ -36,29 +36,40 @@ And get complicated, but battle-tested, email-ready HTML like this:
|
|
36
36
|
</table>
|
37
37
|
```
|
38
38
|
|
39
|
-
##
|
39
|
+
## Getting Started
|
40
40
|
|
41
|
-
Add
|
41
|
+
Add the following gems to your Gemfile:
|
42
42
|
|
43
|
-
|
44
|
-
|
45
|
-
|
43
|
+
```ruby
|
44
|
+
gem 'inky-rb', require: 'inky'
|
45
|
+
# Stylesheet inlining for email **
|
46
|
+
gem 'premailer-rails'
|
47
|
+
```
|
46
48
|
|
47
|
-
|
49
|
+
Then execute:
|
48
50
|
|
49
|
-
|
51
|
+
```bash
|
52
|
+
bundle install
|
53
|
+
```
|
50
54
|
|
51
|
-
|
55
|
+
Make sure that the stylesheet included in your email layout imports the Foundation for Emails styles:
|
52
56
|
|
53
|
-
|
57
|
+
```scss
|
58
|
+
// my_awesome_emails_stylesheet.scss
|
59
|
+
@import "foundation-emails";
|
60
|
+
```
|
54
61
|
|
55
|
-
|
62
|
+
Rename your email templates to use the `.inky` file extension. Note that you'll still be able to use ERB within the `.inky` templates:
|
56
63
|
|
57
|
-
Simply use the file extension `.inky` and make sure your email layout includes a scss file that includes the foundation-emails styles.
|
58
64
|
```
|
59
|
-
|
65
|
+
welcome.html => welcome.html.inky
|
66
|
+
pw_reset.html.erb => pw_reset.html.inky
|
60
67
|
```
|
61
68
|
|
69
|
+
You're all set!
|
70
|
+
|
71
|
+
** The majority of email clients ignore linked stylesheets. By inlining your referenced styles, `premailer-rails` lets you keep your markup and stylesheets in separate files.
|
72
|
+
|
62
73
|
## Custom Elements
|
63
74
|
|
64
75
|
Inky simplifies the process of creating HTML emails by expanding out simple tags like `<row>` and `<column>` into full table syntax. The names of the tags can be changed with the `components` setting.
|
data/lib/inky/rails/version.rb
CHANGED