Skip to content

Latest commit

 

History

History
73 lines (50 loc) · 3.09 KB

README.md

File metadata and controls

73 lines (50 loc) · 3.09 KB
Raw

npm version npm downloads code quality License Nuxt

Simple social sharing for your Nuxt Sites

Documentation | Release Notes | Demo

🌟 Features

  • Provides a minimal config <SocialShare> component
  • The component is unstyled by default for easy integration in any design
  • Optional styled version, that can still be further customized
  • A useSocialShare composable is exposed, to provide even more flexibility if needed
  • Many major social networks supported

📖 Documentation

The full docs are available in a dedicated documentation website

🤝 Contributing

Note

If you want to contribute you can start by reading the Contributing guidelines.

Note

Contributions to add more networks are welcome, but keep in mind that PR will be accepted only for networks that have a documentation available in English among other languages.

  • Clone this repository
  • Enable Corepack using corepack enable
  • Install dependencies using pnpm install
  • Run pnpm dev:prepare to generate type stubs.
  • Use pnpm dev to start playground in development mode.
  • Lint any new edit by running pnpm lint --fix

📝 License

MIT

© 2023-present Stefano Bartoletti