nuxt-newsletter

Open source MIT TypeScript

Website GitHub

Stars

Forks

Issues

Watchers

3 years

Last Commit

CMS Plugins & Extensions

About nuxt-newsletter

[![nuxt-newsletter](https://nuxt-newsletter.netlify.app/preview.png)](https://nuxt-newsletter.netlify.app) # nuxt-newsletter [![npm version][npm-version-src]][npm-version-href] [![npm downloads][npm-downloads-src]][npm-downloads-href] [![Github Actions CI][github-actions-ci-src]][github-actions-ci-href] [![License][license-src]][license-href] > Newsletter module for [Nuxt 3](https://v3.nuxtjs.org) - [✨  Release Notes](https://github.com/baroshem/nuxt-newsletter/releases) - [📖  Read the documentation](https://nuxt-newsletter.netlify.app) ## Features - Nuxt 3 ready - Easy integration with Mailchimp, Revue, Buttondown - Unstyled NewletterForm.vue component - Handy useNewsletterSubscribe composable - TypeScript support [📖  Read the documentation](https://nuxt-newsletter.netlify.app) ## Setup ```sh yarn add nuxt-newsletter # yarn npm i nuxt-newsletter # npm ``` ## Basic usage Firstly, you need to add `nuxt-newsletter` to your Nuxt config. ```javascript // nuxt.config.js { modules ...

Platforms

Web Self-hosted

Languages

TypeScript

Links

Website Source Code

Published by

baroshem

Visit View Profile

README.md

View on GitHub

nuxt-newsletter

Newsletter module for Nuxt 3

Features

Nuxt 3 ready
Easy integration with Mailchimp, Revue, Buttondown
Unstyled NewletterForm.vue component
Handy useNewsletterSubscribe composable
TypeScript support

📖 Read the documentation

Setup

yarn add nuxt-newsletter # yarn
npm i nuxt-newsletter # npm

Basic usage

Firstly, you need to add nuxt-newsletter to your Nuxt config.

// nuxt.config.js

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

Then you can start using nuxt-newsletter in your app!

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

Development

Clone this repository
Install dependencies using yarn install or npm install
Prepare playground environment using yarn dev:prepare or npm run dev:prepare
Start development server using yarn dev or npm run dev

License

MIT License