# vuepress-plugin-mailchimp

> A VuePress plugin for Mailchimp subscriptions

Latest version **1.4.2** (published 2020-03-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install vuepress-plugin-mailchimp
pnpm add vuepress-plugin-mailchimp
yarn add vuepress-plugin-mailchimp
bun add vuepress-plugin-mailchimp
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.4.2 |
| Published | 2020-03-27 |
| First published | 2019-12-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 13.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 7 |
| Author | Billyyyyy3320 |
| Maintainers | newsbielt703 |
| Keywords | mailchimp, newsletter, plugin, vuepress |

## Links

- npm: https://www.npmjs.com/package/vuepress-plugin-mailchimp
- Repository: https://github.com/newsbielt703/vuepress-plugin-mailchimp
- Issues: https://github.com/newsbielt703/vuepress-plugin-mailchimp/issues
- npm.io page: https://npm.io/package/vuepress-plugin-mailchimp

## Dependencies (2)

- [jsonp](https://npm.io/package/jsonp.md) ^0.2.1
- [query-string](https://npm.io/package/query-string.md) ^6.9.0

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 1.4.2 (latest) — 2020-03-27
- 1.4.1 — 2020-01-02
- 1.4.0 — 2020-01-01
- 1.3.1 — 2019-12-22
- 1.3.0 — 2019-12-22
- 1.2.0 — 2019-12-14
- 1.1.1 — 2019-12-14
- 1.1.0 — 2019-12-14
- 1.0.0 — 2019-12-01

## README

# vuepress-plugin-mailchimp

[![NPM version](https://img.shields.io/npm/v/vuepress-plugin-mailchimp)](https://www.npmjs.com/package/vuepress-plugin-mailchimp)
[![NPM LICENSE](https://badgen.net/npm/license/vuepress-plugin-mailchimp)](https://github.com/newsbielt703/vuepress-plugin-mailchimp/blob/master/LICENSE)
[![Circle ci](https://badgen.net/circleci/github/newsbielt703/vuepress-plugin-mailchimp)](https://circleci.com/gh/newsbielt703/workflows/vuepress-plugin-mailchimp)
[![LGTM](https://badgen.net/lgtm/grade/g/newsbielt703/vuepress-plugin-mailchimp)](https://lgtm.com/projects/g/newsbielt703/vuepress-plugin-mailchimp)

Simplifies subscribing new email addresses to a Mailchimp email list.

## Install

First of all, you have to sign up for [Mailchimp](https://mailchimp.com/).

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

## Usage

Take a look at [Using a Plugin](https://vuepress.vuejs.org/plugin/using-a-plugin.html).

```javascript
// .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` file.

- Source code:[SimpleNewsletter.vue](https://github.com/newsbielt703/vuepress-plugin-mailchimp/blob/master/src/SimpleNewsletter.vue)
- Usage:

```md
// .md file

...
your content
...

<SimpleNewsletter/>
```

or

```vue
// .vue file

<template>
  <SimplePagination />
</template>

<script>
import { SimpleNewsletter } from "vuepress-plugin-mailchimp/src/SimpleNewsletter";
export default {
  components: {
    SimpleNewsletter
  }
};
</script>
```

Check out the full [documentation](https://vuepress-plugin-mailchimp.billyyyyy3320.com/).

## License

MIT © [Billyyyyy3320](https://github.com/newsbielt703)

---
_Source: https://npm.io/package/vuepress-plugin-mailchimp · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._