https://github.com/ntnyq/vuepress-plugin-social-share

:mega: Social sharing plugin for VuePress
https://github.com/ntnyq/vuepress-plugin-social-share

facebook share sns social twitter vuepress vuepress-next vuepress-plugin vuepress2 vuepress2-plugin

Last synced: 4 days ago
JSON representation

:mega: Social sharing plugin for VuePress

• Host: GitHub
• URL: https://github.com/ntnyq/vuepress-plugin-social-share
• Owner: ntnyq
• License: mit
• Created: 2019-08-11T04:37:35.000Z (over 5 years ago)
• Default Branch: next
• Last Pushed: 2024-10-28T06:03:51.000Z (17 days ago)
• Last Synced: 2024-10-28T08:09:34.249Z (17 days ago)
• Topics: facebook, share, sns, social, twitter, vuepress, vuepress-next, vuepress-plugin, vuepress2, vuepress2-plugin
• Language: TypeScript
• Homepage: https://social-share.ntnyq.com
• Size: 2.51 MB
• Stars: 33
• Watchers: 3
• Forks: 7
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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/next.svg)](https://www.npmjs.com/package/vuepress-plugin-social-share/v/next)

[![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://v2.vuepress.vuejs.org)

:book: [Online demo and Docs](https://social-share.ntnyq.com)

If you are upgrading this plugin to v2, See [Migration guide from v1](https://social-share.ntnyq.com/guide/#migration-from-v1).

## ⚠️ Note

Still using VuePress v1?

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

## Install

```bash

npm install vuepress-plugin-social-share@next -D

```

```bash

yarn add vuepress-plugin-social-share@next -D

```

```bash

pnpm add vuepress-plugin-social-share@next -D

```

## Usage

```js

import { defineUserConfig } from 'vuepress'

import { socialSharePlugin } from 'vuepress-plugin-social-share'

export default defineUserConfig({

  plugins: [socialSharePlugin()],

})

```

:mag: [Custom options detail](https://social-share.ntnyq.com/guide/#options)

## Prior Art

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

## License

[MIT](./LICENSE) License © 2019-PRESENT [ntnyq](https://github.com/ntnyq)