arm
/
hermes
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Merge pull request #1 from Thiht/master 

Minor style modifications
This commit is contained in:
Mathieu Cornic 2017-04-01 22:44:44 +02:00 committed by GitHub
parent 998165d01d 8ffbdf7305
commit ef71eecb24
4 changed files with 127 additions and 124 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
CONTRIBUTING.md
View File

@ -14,7 +14,7 @@ Excellent! You've come to the right place.
## Theming Instructions ## Theming Instructions
This file contains instructions on adding themes to Mailgen: This file contains instructions on adding themes to Hermes:
* [Using a Custom Theme](#using-a-custom-theme) * [Using a Custom Theme](#using-a-custom-theme)
* [Creating a Built-In Theme](#creating-a-built-in-theme) * [Creating a Built-In Theme](#creating-a-built-in-theme)
@ -26,7 +26,7 @@ This file contains instructions on adding themes to Mailgen:
### Using a Custom Theme ### Using a Custom Theme
If you want to supply your own **custom theme** for Hermes to use (but don't want it included with Mailgen): If you want to supply your own **custom theme** for Hermes to use (but don't want it included with Hermes):
1. Create a new struct implementing `Theme` interface ([hermes.go](hermes.go)). A real-life example is in [default.go](default.go) 1. Create a new struct implementing `Theme` interface ([hermes.go](hermes.go)). A real-life example is in [default.go](default.go)
2. Supply your new theme at hermes creation 2. Supply your new theme at hermes creation
@ -68,7 +68,7 @@ h := hermes.Hermes{
### Creating a Built-In Theme ### Creating a Built-In Theme
If you want to create a new **built-in** Mailgen theme: If you want to create a new **built-in** Hermes theme:
1. Fork the repository to your GitHub account and clone it to your computer 1. Fork the repository to your GitHub account and clone it to your computer
2. Create a new Go file named after your new theme 2. Create a new Go file named after your new theme

25
README.md
View File

@ -5,12 +5,12 @@
[![Go Coverage](https://codecov.io/github/matcornic/hermes/coverage.svg)](https://codecov.io/github/matcornic/hermes/) [![Go Coverage](https://codecov.io/github/matcornic/hermes/coverage.svg)](https://codecov.io/github/matcornic/hermes/)
[![Godoc](https://godoc.org/github.com/matcornic/hermes?status.svg)](https://godoc.org/github.com/matcornic/hermes) [![Godoc](https://godoc.org/github.com/matcornic/hermes?status.svg)](https://godoc.org/github.com/matcornic/hermes)
Hermes is the Go port of the great [mailgen](https://github.com/eladnava/mailgen) engine for Node.js. Check their work, it's awesome ! Hermes is the Go port of the great [mailgen](https://github.com/eladnava/mailgen) engine for Node.js. Check their work, it's awesome!
It's a package that generates clean, responsive HTML e-mails for sending transactional e-mails (welcome e-mail, reset password e-mails, receipt e-mails and so on). It's a package that generates clean, responsive HTML e-mails for sending transactional e-mails (welcome e-mails, reset password e-mails, receipt e-mails and so on).
# Demo # Demo
<img src="https://raw.github.com/matcornic/hermes/master/screens/default/welcome.png" height="400" /> <img src="https://raw.github.com/matcornic/hermes/master/screens/default/reset.png" height="400" /> <img src="https://raw.github.com/matcornic/hermes/master/screens/default/receipt.png" height="400" /> <img src="screens/default/welcome.png" height="400" /> <img src="screens/default/reset.png" height="400" /> <img src="screens/default/receipt.png" height="400" />
# Usage # Usage
@ -31,8 +31,8 @@ h := hermes.Hermes{
// Appears in header & footer of e-mails // Appears in header & footer of e-mails
Name: "Hermes", Name: "Hermes",
Link: "https://example-hermes.com/", Link: "https://example-hermes.com/",
//Option product logo // Option product logo
//Logo: "http://www.duchess-france.org/wp-content/uploads/2016/01/gopher.png", // Logo: "http://www.duchess-france.org/wp-content/uploads/2016/01/gopher.png",
}, },
} }
``` ```
@ -62,7 +62,7 @@ email := hermes.Email{
}, },
} }
// Generate an HTML email with the provided contents(for modern clients) // Generate an HTML email with the provided contents (for modern clients)
emailBody, err := h.GenerateHTML(email) emailBody, err := h.GenerateHTML(email)
if err != nil { if err != nil {
panic(err) // Tip: Handle error with something else than a panic ;) panic(err) // Tip: Handle error with something else than a panic ;)
@ -74,7 +74,7 @@ if err != nil {
panic(err) // Tip: Handle error with something else than a panic ;) panic(err) // Tip: Handle error with something else than a panic ;)
} }
// Optionnaly, preview the generated HTML e-mail by writing it to a local file // Optionally, preview the generated HTML e-mail by writing it to a local file
err = ioutil.WriteFile("preview.html", []byte(emailBody), 0644) err = ioutil.WriteFile("preview.html", []byte(emailBody), 0644)
if err != nil { if err != nil {
panic(err) // Tip: Handle error with something else than a panic ;) panic(err) // Tip: Handle error with something else than a panic ;)
@ -83,7 +83,7 @@ if err != nil {
This code would output the following HTML template: This code would output the following HTML template:
<img src="https://raw.github.com/matcornic/hermes/master/screens/demo.png" height="400" /> <img src="screens/demo.png" height="400" />
> Theme templates will be embedded in your application binary. If you want to use external templates (for configuration), use your own theme by implementing `hermes.Theme` interface with code searching for your files. > Theme templates will be embedded in your application binary. If you want to use external templates (for configuration), use your own theme by implementing `hermes.Theme` interface with code searching for your files.
@ -113,7 +113,7 @@ The following open-source themes are bundled with this package:
* `default` by [Postmark Transactional Email Templates](https://github.com/wildbit/postmark-templates) * `default` by [Postmark Transactional Email Templates](https://github.com/wildbit/postmark-templates)
<img src="https://raw.github.com/matcornic/hermes/master/screens/default/welcome.png" height="200" /> <img src="https://raw.github.com/matcornic/hermes/master/screens/default/reset.png" height="200" /> <img src="https://raw.github.com/matcornic/hermes/master/screens/default/receipt.png" height="200" /> <img src="screens/default/welcome.png" height="200" /> <img src="screens/default/reset.png" height="200" /> <img src="screens/default/receipt.png" height="200" />
## RTL Support ## RTL Support
@ -129,13 +129,13 @@ h := hermes.Hermes {
## Language Customizations ## Language Customizations
To customize the e-mail greeting (Hi) or signature (Yours truly), supply custom strings within the e-mail `Body`: To customize the e-mail's greeting ("Hi") or signature ("Yours truly"), supply custom strings within the e-mail's `Body`:
```go ```go
email := hermes.Email{ email := hermes.Email{
Body: hermes.Body{ Body: hermes.Body{
Greeting: "Dear", Greeting: "Dear",
Signature: "Sincerly", Signature: "Sincerely",
}, },
} }
``` ```
@ -146,7 +146,7 @@ To use a custom title string rather than a greeting/name introduction, provide i
email := hermes.Email{ email := hermes.Email{
Body: hermes.Body{ Body: hermes.Body{
// Title will override `Name` // Title will override `Name`
Title: "Welcome to Mailgen", Title: "Welcome to Hermes",
}, },
} }
``` ```
@ -176,7 +176,6 @@ Hermes supports injecting custom elements such as dictionaries, tables and actio
To inject an action button in to the e-mail, supply the `Actions` object as follows: To inject an action button in to the e-mail, supply the `Actions` object as follows:
```go ```go
email := hermes.Email{ email := hermes.Email{
Body: hermes.Body{ Body: hermes.Body{

10
default.go
View File

@ -227,6 +227,7 @@ func (dt *Default) HTMLTemplate() string {
</a> </a>
</td> </td>
</tr> </tr>
<!-- Email Body --> <!-- Email Body -->
<tr> <tr>
<td class="email-body" width="100%"> <td class="email-body" width="100%">
@ -314,7 +315,9 @@ func (dt *Default) HTMLTemplate() string {
<tr> <tr>
<td align="center"> <td align="center">
<div> <div>
<a href="{{ $action.Button.Link }}" class="button" style="background-color: {{ $action.Button.Color }}" target="_blank">{{ $action.Button.Text }}</a> <a href="{{ $action.Button.Link }}" class="button" style="background-color: {{ $action.Button.Color }}" target="_blank">
{{ $action.Button.Text }}
</a>
</div> </div>
</td> </td>
</tr> </tr>
@ -333,13 +336,14 @@ func (dt *Default) HTMLTemplate() string {
<p> <p>
{{.Email.Body.Signature}}, {{.Email.Body.Signature}},
<br> <br />
{{.Hermes.Product.Name}} {{.Hermes.Product.Name}}
</p> </p>
{{ with .Email.Body.Actions }} {{ with .Email.Body.Actions }}
<table class="body-sub"> <table class="body-sub">
<tbody><tr> <tbody>
<tr>
{{ range $action := . }} {{ range $action := . }}
<td> <td>
<p class="sub">If you’re having trouble with the button '{{ $action.Button.Text }}', copy and paste the URL below into your web browser.</p> <p class="sub">If you’re having trouble with the button '{{ $action.Button.Text }}', copy and paste the URL below into your web browser.</p>

2
hermes.go
View File

@ -124,7 +124,7 @@ func setDefaultHermesValues(h *Hermes) error {
Copyright: "Copyright © 2017 Hermes. All rights reserved.", Copyright: "Copyright © 2017 Hermes. All rights reserved.",
}, },
} }
// Merge the given hermes engine coniguration with default one // Merge the given hermes engine configuration with default one
// Default one overrides all zero values // Default one overrides all zero values
err := mergo.Merge(h, defaultHermes) err := mergo.Merge(h, defaultHermes)
if err != nil { if err != nil {