vuepress-plugin-social-share/README.md

Social sharing plugin for VuePress

# vuepress-plugin-social-share

[![CI](https://github.com/ntnyq/vuepress-plugin-social-share/workflows/CI/badge.svg)](https://github.com/ntnyq/vuepress-plugin-social-share/actions)
[![NPM VERSION](https://img.shields.io/npm/v/vuepress-plugin-social-share.svg)](https://www.npmjs.com/package/vuepress-plugin-social-share)
[![NPM DOWNLOADS](https://img.shields.io/npm/dy/vuepress-plugin-social-share.svg)](https://www.npmjs.com/package/vuepress-plugin-social-share)
[![LICENSE](https://img.shields.io/github/license/ntnyq/vuepress-plugin-social-share.svg)](https://github.com/ntnyq/vuepress-plugin-social-share/blob/main/LICENSE)

:mega: Social sharing plugin for [VuePress](https://vuepress.vuejs.org)

:book: [Live Demo and Docs](https://sns.goyfe.com)

## ⚠️ Note

Looking for VuePress v2 support?

Please checkout branch [next](https://github.com/ntnyq/vuepress-plugin-social-share/tree/next) for detail.

## Install

```bash
$ npm install vuepress-plugin-social-share -D
# OR
$ yarn add vuepress-plugin-social-share -D
```

## Usage

Add config to `.vuepress/config.js`:

```js
module.exports = {
  plugins: [`social-share`],
}
```

:mag: [Custom options detail](https://sns.goyfe.com/guide)

## Prior Art

Deeply thank to [vue-social-sharing](https://github.com/nicolasbeauvais/vue-social-sharing) for the component api source code.

## License

[MIT](./LICENSE) © [@ntnyq](https://github.com/ntnyq)