EmailSubscribe

<EmailSubscribe> puts an email signup form inline on a docs page with a single MDX tag. When you've connected a provider in the dashboard, it renders a Jamdesk-hosted form that writes new subscribers straight to your audience. Without a connected provider, it can host another service's paste-in embed instead. It's built for changelog and release-notes pages, where readers want to hear about what's new.

Quick Start

Connect a provider in the dashboard first, then add the tag with that provider's id:

<EmailSubscribe provider="resend" />

That renders a labeled email field and a Subscribe button. On submit, the address is added to the audience you connected. The same tag works for any native provider (mailchimp, kit, loops, beehiiv, brevo, or sendgrid) once that provider is connected.

Add an optional heading and supporting line:

<EmailSubscribe
  provider="resend"
  title="Get release notes"
  description="One email when we ship something new. No spam."
/>

Props

Native vs. embed

The provider you pass decides how the form behaves:

• Native providers (resend, mailchimp, kit, loops, beehiiv, brevo, sendgrid) render a Jamdesk-hosted form. Jamdesk captures the address and adds it through your connected key. This is the path that needs a provider connected in the dashboard.
• Embed-only providers (buttondown, substack) render that service's own form or iframe. No key to connect: you supply your username and the visitor submits to the provider directly.

Embed-only providers

Buttondown and Substack work without a dashboard connection. Pass your account username:

<EmailSubscribe provider="buttondown" username="acme" />
<EmailSubscribe provider="substack" username="acme" />

Escape hatch: paste any embed

For a provider Jamdesk doesn't have a shorthand for, paste its embed markup into snippet. It renders as-is on the published page:

<EmailSubscribe snippet={`<form action="https://example.com/subscribe">...</form>`} />

Compact mode

A full email field plus a Subscribe button is a lot of weight to drop into the middle of a page. Set collapsed and the native form starts as a single Subscribe button instead. A reader who clicks it gets the full field, inline, without a page reload:

<EmailSubscribe provider="resend" collapsed title="Subscribe to updates" />

The button's label comes from title (it falls back to "Subscribe to updates" when you don't set one). This is native-only. Embed providers render their own markup, so Jamdesk has nothing to collapse.

Returning subscribers

Once a reader subscribes through a native form, the browser remembers it. On their next visit, instead of the full form they see a short line: You're subscribed to the newsletter. Nobody gets asked to sign up for something they already joined.

If they want to add a second address, the line has a "Use a different email?" control that reopens the full form on the spot. The memory is per-browser (it lives in localStorage, not your audience), so clearing site data or switching browsers shows the form again. Nothing to configure: every native form does this.

Auto-place on changelog pages

Instead of adding the tag to every release page by hand, mount the form automatically on changelog pages. In docs.json, set the newsletter integration's placement to changelog:

{
  "integrations": {
    "newsletter": {
      "provider": "resend",
      "title": "Get release notes",
      "placement": "changelog"
    }
  }
}

With placement: "changelog", the form mounts on every changelog page (any page with rss: true). To skip it on one such page, set newsletter: false in that page's frontmatter. If a page already has a hand-placed <EmailSubscribe>, the auto-placement steps aside so you don't get two forms.

The full integrations.newsletter block accepts the same fields as the component (provider, title, description, collapsed, username, snippet, height) plus placement (none, the default, or changelog).

What's Next?