Skip to content

Latest commit

 

History

History
35 lines (25 loc) · 1.01 KB

README.md

File metadata and controls

35 lines (25 loc) · 1.01 KB
Raw

antlion

Antlion is a WIP but usable email generator. Using a collection of "blocks" you can compose emails that will render reliably in most-all email clients, in plain-text and HTML.

Development of Antlion is largely handled by Hussle Inc employees.

blocks

  • alert
  • button
  • code (like verify code, 123456 etc)
  • divider (hr)
  • header (h1)
  • markdown (paragraph + blackfriday parsing)
  • paragraph

quick-start

email := antlion.NewEmail(
	"Hello World!",
	"Preheader text",
	antlion.Header("Hello,"),
	antlion.Paragraph("Lorem ipsum...")
)

textContent := email.RenderText()
htmlContent := email.RenderHTML()

... whatever ...

contributing

Feel free to contribute new components, please create a PR with screenshots. If you have access to something like Litmus or Email on Acid, please use these tools first before submitting a PR, as we will not merge content that does not acceptably render on all devices.