https://github.com/gocom/dense
jQuery plugin that blows your visitors' retinas
https://github.com/gocom/dense
Last synced: 5 months ago
JSON representation
jQuery plugin that blows your visitors' retinas
- Host: GitHub
- URL: https://github.com/gocom/dense
- Owner: gocom
- License: mit
- Created: 2013-06-02T20:47:57.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2016-09-28T11:51:02.000Z (about 9 years ago)
- Last Synced: 2025-07-18T16:52:21.641Z (5 months ago)
- Language: JavaScript
- Homepage: http://dense.rah.pw
- Size: 1.51 MB
- Stars: 212
- Watchers: 9
- Forks: 21
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-jquery - Dense.js - Serving retina-ready, high pixel ratio images with ease. (Animation / Images, Maps and Charts)
README
Dense.js
=====
[Homepage](http://dense.rah.pw) | [Issues](https://github.com/gocom/dense/issues) | [](https://travis-ci.org/gocom/dense)
Dense is a jQuery plugin for serving retina-ready, high pixel ratio images with ease. Small, ease-to-adapt, yet very customizable and works cross-browser. With Dense, your content images get support for ```data-ratiox``` attributes and Apple's retina image naming convention.
Install
-----
[Download package](http://dense.rah.pw/download) or using [Bower](http://bower.io):
$ bower install dense
Usage
-----
Using Dense is simple. Include the plugin and initialize its method:
```html
$('img').dense();
```
For more instructions and options see the [documentation](http://dense.rah.pw).
Build
-----
Dense uses [Grunt](http://gruntjs.com) to run tasks. First make sure that you have all base dependencies installed by running npm in the repository's directory:
$ cd dense
$ npm install
After you have installed all dependencies, you will be able to run tasks using Grunt, like releasing, building, publishing and testing:
$ grunt [task]
Where the ```[task]``` is one of ```test```, ```build```, ```jsdoc``` or ```release```. Tasks ```jsdoc``` and ```release:[major|minor|patch]``` require Java in addition to the Node.js due to the use of JSDoc3.