mailmatic 0.0.1 → 0.0.2
Sign up to get free protection for your applications and to get access to all the features.
- data/README.rdoc +24 -1
- data/VERSION +1 -1
- data/lib/mailmatic.rb +11 -0
- data/mailmatic.gemspec +1 -1
- metadata +3 -3
data/README.rdoc
CHANGED
@@ -1,6 +1,29 @@
|
|
1
1
|
= MailMatic
|
2
2
|
|
3
|
-
|
3
|
+
MailMatic is a mashup of tools designed to help you create self-contained HTML emails, with inlined styles. It uses StaticMatic[https://github.com/staticmatic/staticmatic] to let you develop your emails using Haml[http://haml-lang.com/], Sass[http://sass-lang.com/], and Compass[http://compass-style.org/]. It then uses Premailer[https://github.com/alexdunae/premailer] to convert your generated HTML into HTML without external stylesheets, where all the style information is inlined as HTML attributes. This is critical for creating HTML emails that work well.
|
4
|
+
|
5
|
+
== Installation
|
6
|
+
|
7
|
+
Install the gem:
|
8
|
+
|
9
|
+
gem install mailmatic
|
10
|
+
|
11
|
+
Initialize a directory where you will manage your static emails, e.g.:
|
12
|
+
|
13
|
+
mailmatic setup my_emails_dir
|
14
|
+
|
15
|
+
This generates a StaticMatic project directory structure. You can now edit your layouts, pages, and stylesheets under the `src` directory. You create new emails by creating documents under the `pages` directory. You can make subdirectories under here, and you can create partials that start with an underscore.
|
16
|
+
|
17
|
+
NOTE: All of your Haml files should be named `filename.haml`, NOT `filename.html.haml`.
|
18
|
+
|
19
|
+
For information on the use of partials, layouts, and helpers, see StaticMatic's documentation at http://staticmatic.rubyforge.org/how_to_use.html
|
20
|
+
|
21
|
+
Once you are ready to generate the emails, run:
|
22
|
+
|
23
|
+
mailmatic build my_emails_dir
|
24
|
+
|
25
|
+
Then, you will see all of your generated emails in the `my_emails_dir/emails` directory.
|
26
|
+
|
4
27
|
|
5
28
|
== Contributing to MailMatic
|
6
29
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
0.0.
|
1
|
+
0.0.2
|
data/lib/mailmatic.rb
CHANGED
@@ -29,6 +29,17 @@ module MailMatic
|
|
29
29
|
f << premailer.to_inline_css
|
30
30
|
end
|
31
31
|
puts "created #{outfile}"
|
32
|
+
|
33
|
+
if premailer.warnings.any?
|
34
|
+
puts
|
35
|
+
puts "WARNING: #{outfile}"
|
36
|
+
puts "-" * 79
|
37
|
+
premailer.warnings.each do |w|
|
38
|
+
puts " [#{w[:level]}] #{w[:message]} may not render properly in #{w[:clients]}"
|
39
|
+
end
|
40
|
+
puts
|
41
|
+
end
|
42
|
+
|
32
43
|
return 0
|
33
44
|
rescue Exception => e
|
34
45
|
puts "failed to create #{outfile}"
|
data/mailmatic.gemspec
CHANGED
metadata
CHANGED
@@ -1,13 +1,13 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: mailmatic
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
hash:
|
4
|
+
hash: 27
|
5
5
|
prerelease:
|
6
6
|
segments:
|
7
7
|
- 0
|
8
8
|
- 0
|
9
|
-
-
|
10
|
-
version: 0.0.
|
9
|
+
- 2
|
10
|
+
version: 0.0.2
|
11
11
|
platform: ruby
|
12
12
|
authors:
|
13
13
|
- Scott W. Bradley
|