Skip to content

Latest commit

 

History

History
68 lines (48 loc) · 1.87 KB

README.md

File metadata and controls

68 lines (48 loc) · 1.87 KB

vuepress-plugin-mailchimp

NPM version NPM LICENSE Circle ci LGTM

Simplifies subscribing new email addresses to a Mailchimp email list.

Install

First of all, you have to sign up for Mailchimp.

yarn add vuepress-plugin-mailchimp -D
# OR npm install vuepress-plugin-mailchimp -D

Usage

Take a look at Using a Plugin.

// .vuepress/config.js
module.exports = {
  plugins: [
    "vuepress-plugin-mailchimp",
    {
      // You need to provide this plugin with your Mailchimp endpoint in order for it
      // to know where to save the email address. See more detail in Config section.
      endpoint: ""
    }
  ]
};

<SimpleNewsletter/>

This plugin provides a out-of-box component. Since it has been registered automatically, you can simply use it in your .md or .vue files.

// .md file

...
your content
...

<SimpleNewsletter/>

or

// .vue file

<template>
  <SimplePagination />
</template>

Check out the full documentation.

License

MIT © Billyyyyy3320