method EmailKit.prototype.render
EmailKit.prototype.render(unnamed 0: { subject: string; preheader: string; markdown: string; }): RenderedEmail

Returns the email written as markdown: the Markdown itself is the plain-text part, and its blocks, drawn in this kit's style, are the HTML. Each template writes its email once this way. The blocks map as follows.

  • # Title is the heading; an *emphasised* paragraph above it, the eyebrow. Elsewhere an emphasised paragraph is a note.
  • ## Section starts a section, with its divider; ### Name a subhead.
  • A link alone in a paragraph is a button, an image alone a wide image, and a fenced block a box for a raw link.
  • A list item whose text starts with an image, then a link, is a row with that thumbnail and the link as its title; what follows is its detail, and an emphasised word right after the link a pill. Other items are sentences, where emphasis marks the date. A numbered list ranks its rows, and a quote under an item is set as one.
  • A bold number is a figure.
  • What follows the last --- is the footer.

Parameters

unnamed 0: { subject: string; preheader: string; markdown: string; }

Return Type

Usage

import { EmailKit } from "api/mail/layout.ts";