{"id":26175385,"url":"https://github.com/aslansky/gulp-sprite","last_synced_at":"2025-07-03T05:05:06.768Z","repository":{"id":13364542,"uuid":"16052150","full_name":"aslansky/gulp-sprite","owner":"aslansky","description":"gulp task for creating image sprites and the corresponding stylesheets","archived":false,"fork":false,"pushed_at":"2015-11-20T15:49:25.000Z","size":429,"stargazers_count":15,"open_issues_count":4,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-05-18T13:08:49.283Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aslansky.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-01-19T19:01:45.000Z","updated_at":"2017-03-26T05:12:37.000Z","dependencies_parsed_at":"2022-09-03T01:21:52.690Z","dependency_job_id":null,"html_url":"https://github.com/aslansky/gulp-sprite","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/aslansky/gulp-sprite","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aslansky%2Fgulp-sprite","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aslansky%2Fgulp-sprite/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aslansky%2Fgulp-sprite/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aslansky%2Fgulp-sprite/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aslansky","download_url":"https://codeload.github.com/aslansky/gulp-sprite/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aslansky%2Fgulp-sprite/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262409570,"owners_count":23306663,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-03-11T20:56:25.874Z","updated_at":"2025-07-03T05:05:06.746Z","avatar_url":"https://github.com/aslansky.png","language":"JavaScript","readme":"# [gulp](http://gulpjs.com)-sprite [![NPM version](https://badge.fury.io/js/gulp-sprite.png)](http://badge.fury.io/js/gulp-sprite) [![Build Status](https://travis-ci.org/aslansky/gulp-sprite.png?branch=master)](https://travis-ci.org/aslansky/gulp-sprite) [![Dependencies](https://david-dm.org/aslansky/gulp-sprite.png)](https://david-dm.org/aslansky/gulp-sprite)\n\n\u003e [gulp](http://gulpjs.com) task for creating a image sprite and the corresponding stylesheets\n\n## DEPRECATION NOTICE\n\nPlease use [css-sprite](https://github.com/aslansky/css-sprite) instead of this gulp plugin.\n\n\n## Requirements\n\n`gulp-sprite` requires [node-canvas](https://github.com/learnboost/node-canvas) which depends on [Cairo](http://cairographics.org/).\n\nPlease refer the [installation guide](https://github.com/learnboost/node-canvas/wiki).\n\n## Install\n\nInstall with [npm](https://npmjs.org/package/gulp-sprite)\n\n```\nnpm install --save-dev gulp-sprite\n```\n\n## Example\n\n```js\nvar gulp = require('gulp');\nvar sprite = require('gulp-sprite');\n\ngulp.task('sprites', function () {\n    gulp.src('./src/img/*.png')\n      .pipe(sprite('sprites.png', {\n        imagePath: 'dist/img',\n        cssPath: './src/scss/utils/',\n        preprocessor: 'scss'\n      }))\n      .pipe(gulp.dest('./dist/img/'));\n});\n```\n\n## API\n\n### sprite(sprite-name, options)\n\n#### sprite-name\n\n**description:** The name of the sprite file.\n\n### Configuration Options\n\n#### imagePath\n\n**default:** ''\n\n**description:** The http path to images on the web server (relative to css path or absolute).\n\n### cssPath\n\n**default:** ''\n\n**description:** The path where stylesheet file should be created. If ommited no stylesheet file will be created.\n\n### prefix\n\n**default:** ''\n\n**description:** The prefix for the stylesheet file\n\n### preprocessor\n\n**default:** 'css'\n\n**description:** The output style for the stylesheets.\nOne of: css, less, sass, scss or stylus.\n\n### orientation\n\n**default:** vertical\n\n**description:** The orientation in which the images are aligned in the sprite\nOn of: vertical, horizontal\n\n### margin\n\n**default:** 5\n\n**description:** The space between images within the sprite\n\n## License\n\nMIT © [Alexander Slansky](http://slansky.net)\n\n[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/aslansky/gulp-sprite/trend.png)](https://bitdeli.com/free \"Bitdeli Badge\")\n","funding_links":[],"categories":["Sprite Generators","Generators"],"sub_categories":["Meetups"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faslansky%2Fgulp-sprite","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faslansky%2Fgulp-sprite","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faslansky%2Fgulp-sprite/lists"}