Capuchin is a tool for writing email newsletters. It allows you to write content in Markdown and schedule the resulting campaign for delivery via the MailChimp API.
You can think of Capuchin as "Jekyll for email newsletters".
If you want fancy HTML you probably want to stick to MailChimp's WYSIWYG editor, but for a newsletter where the primary content is text (and some links) give Capuchin a shot.
You don't need to add it to your Gemfile - it's best kept as a system-wide gem. All you need to do is install it from the command line:
$ gem install capuchin
This installs the command line tool
The directory structure is as follows:
. ├── .env ├── _config.yml └── _emails ├── 2013-09-01-selling-software-products.md └── 2013-09-08-creating-value-as-a-consultant.md
capuchin new PATHwill scaffold the directory structure in PATH
capuchin create "Email Subject"will generate a Markdown email file with the provided subject
capuchin schedule _emails/PATH_TO_EMAIL.mdwill process the input email, and schedule it for MailChimp delivery based on the date in the YAML front-matter (defaults to the date in the filename)
Capuchin leverages MailChimps templating system (instead of doing templating
locally). To have your content inserted into your email, make sure your template
mc:edit="main" in it.
You need to set the template ID from MailChimp in
_config.yml (see below).
Set your MailChimp API key (You can see your API keys here) in the
DO NOT CHECK THIS INTO SOURCE CODE IF YOUR REPOSITORY IS PUBLICLY ACCESSIBLE!!
Specify Capuchin configuration in
capuchin: from_email: "email@example.com" from_name: "Joe Cool" list_id: "ee90847678" template_id: 71337 # Delivery time is 24 Hour format in GMT delivery_time: "08:30:00"
Given a file
_emails\2013-09-01-selling-software-products.md with these
contents (and the same configuration as above):
--- subject: Selling Software Products --- This is an email about how to sell software!
capuchin schedule _emails\2013-09-01-selling-software-products.md to schedule
this campaign in MailChimp to be sent on 2013-09-01 at 08:30 AM (GMT) to all members of
the list with a Subject of "Selling Software Products".
A capuchin monkey are New World monkeys of the subfamily Cebinae. They are considered the most intelligent New World monkeys, known especially for their long-term tool usage and social structures. Capuchin monkeys are sometimes referred to as "nature's butlers" because of their historic use as service animals.