Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cferdinandi/social-sharing
Add social sharing links and buttons without the bloat.
https://github.com/cferdinandi/social-sharing
Last synced: 2 days ago
JSON representation
Add social sharing links and buttons without the bloat.
- Host: GitHub
- URL: https://github.com/cferdinandi/social-sharing
- Owner: cferdinandi
- License: mit
- Created: 2013-04-03T01:49:07.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2016-08-27T16:50:31.000Z (about 8 years ago)
- Last Synced: 2024-10-12T08:13:27.574Z (23 days ago)
- Language: CSS
- Homepage:
- Size: 69.3 KB
- Stars: 641
- Watchers: 31
- Forks: 50
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Social Sharing [](https://travis-ci.org/cferdinandi/social-sharing)
Add social sharing links and buttons without the bloat.
[Download Social Sharing](https://github.com/cferdinandi/social-sharing/archive/master.zip) / [View the demo](http://cferdinandi.github.io/social-sharing/)
## Getting Started
Compiled and production-ready code can be found in the `dist` directory. The `src` directory contains development code.
### 1. Include Social Sharing on your site.
```html
```
If you're not using the [Kraken boilerplate](http://cferdinandi.github.io/kraken/), you might also need to include button styling.
### 2. Add the markup to your HTML.
**Branded Buttons**
A few simple classes turn `button` and `a` elements into branded social media buttons.
```html
Twitter
Facebook
Google+
LinkedIn
Pinterest
GitHub
VK
Xing
Tumblr
Reddit
```
**Sharing Links**
To include sharing links for Twitter, Facebook, Google+, LinkedIn and more, just add your URL's and titles where indicated in these snippets. Combine with the branded buttons for sharing buttons.
```html
Tweet
Share on Reddit
```
And that's it, you're done. Nice work!
## Installing with Package Managers
You can install Social Sharing with your favorite package manager.
* **NPM:** `npm install cferdinandi/social-sharing`
* **Bower:** `bower install https://github.com/cferdinandi/social-sharing.git`
* **Component:** `component install cferdinandi/social-sharing`
## Working with the Source Files
If you would prefer, you can work with the development code in the `src` directory using the included [Gulp build system](http://gulpjs.com/). This compiles, lints, and minifies code, and runs unit tests. It's the same build system that's used by [Kraken](http://cferdinandi.github.io/kraken/), so it includes some unnecessary tasks and Sass variables but can be dropped right in to the boilerplate without any configuration.
### Dependencies
Make sure these are installed first.
* [Node.js](http://nodejs.org)
* [Gulp](http://gulpjs.com) `sudo npm install -g gulp`
### Quick Start
1. In bash/terminal/command line, `cd` into your project directory.
2. Run `npm install` to install required files.
3. When it's done installing, run one of the task runners to get going:
* `gulp` manually compiles files.
* `gulp watch` automatically compiles files when changes are made and applies changes using [LiveReload](http://livereload.com/).
## Browser Compatibility
Social Sharing works in all modern browsers, and IE 6 and above.
## How to Contribute
In lieu of a formal style guide, take care to maintain the existing coding style. Please apply fixes to both the development and production code. Don't forget to update the version number, and when applicable, the documentation.
## License
The code is available under the [MIT License](LICENSE.md).