@nuxt-modules/newsletter

@nuxtjs/newsletter

Newsletter module for Nuxt

• ✨  Release Notes
• 📖  Read the documentation

Features

• Nuxt 3 ready
• Easy integration with Mailchimp, Revue, Buttondown
• Useful (optional) NewletterForm.vue component
• Handy useNewsletterSubscribe composable
• [Coming soon] More newsletter providers
• TypeScript support

📖  Read the documentation

Setup

yarn add @nuxtjs/newsletter # yarn
npm i @nuxtjs/newsletter # npm

Basic usage

Firstly, you need to add @nuxtjs/newsletter to your Nuxt config.

// nuxt.config.js

{
    modules: [
        "@nuxtjs/newsletter",
    ],
    newsletter: {
      // mailchimp | revue | buttondown
      <YOUR_NEWSLETTER_PROVIDER>: {
        // options like apiKey
      }
    }
}

Then you can start using @nuxtjs/newsletter in your app!

<template>
  <div>
    <newsletter-form />
  </div>
</template>

Development

1. Clone this repository
2. Install dependencies using yarn install or npm install
3. Start development server using yarn dev or npm run dev

License

MIT License