@liuwave/vuepress-plugin-social-share/README.md

Social sharing plugin for VuePress

# @liuwave/vuepress-plugin-social-share

[![CIRCLECI](https://img.shields.io/circleci/project/liuwave/vuepress-plugin-social-share/master.svg?logo=circleci)](https://circleci.com/gh/liuwave/vuepress-plugin-social-share)
[![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/liuwave/vuepress-plugin-social-share.svg)](https://github.com/liuwave/vuepress-plugin-social-share/blob/master/LICENSE)


## 基于 [ntnyq/vuepress-plugin-social-share](https://github.com/ntnyq/vuepress-plugin-social-share) 做些修改：


- [x] 修改分享图标
- [ ] 增加二维码分享(微信)


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

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

## Status

**WIP** :muscle:

## 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) © [@liuwave](https://github.com/liuwave)