Skip to main content

Install

Install component from your command line.

Getting started

Add the component to your email template. Include styles where needed.
Don’t write markdown straight into the template, as in <Markdown># Hello</Markdown>: Vue collapses the whitespace and line breaks of templates, which markdown depends on. Pass it with the source prop, or interpolate a string into the default slot.

Props

string
Contains the markdown content that will be rendered in the email template. When it’s not given, the text of the default slot is used instead.
object
default:"{}"
Provide custom styles for the containing div that wraps the markdown content
object
default:"{}"
Provide custom styles for the corresponding html element (p, h1, h2, etc.)
Note: Passing a custom style for an element overrides the default styles.

Support

All components were tested using the most popular email clients.
GmailGmail
Apple MailApple Mail
OutlookOutlook
Yahoo! MailYahoo! Mail
HEYHEY
SuperhumanSuperhuman