Added documentation
This commit is contained in:
parent
c28845e17e
commit
c7f4c33556
26
README.md
26
README.md
|
@ -1,4 +1,28 @@
|
||||||
gulp-sass
|
gulp-sass
|
||||||
=========
|
=========
|
||||||
|
|
||||||
gulp plugin for sass
|
SASS plugin for [gulp](https://github.com/wearefractal/gulp).
|
||||||
|
|
||||||
|
#Install
|
||||||
|
|
||||||
|
```
|
||||||
|
npm install gulp-sass
|
||||||
|
```
|
||||||
|
|
||||||
|
#Usage
|
||||||
|
|
||||||
|
Something like this:
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
var gulp = require('gulp');
|
||||||
|
var sass = require('gulp-sass')
|
||||||
|
|
||||||
|
gulp.task('sass', function () {
|
||||||
|
gulp.src('./scss/*.scss'))
|
||||||
|
.pipe(sass())
|
||||||
|
.pipe(gulp.dest('./css'));
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
Options passed as a hash into ```sass()``` will be passed along to [```node-sass```](https://github.com/andrew/node-sass)
|
||||||
|
|
||||||
|
|
16
index.js
16
index.js
|
@ -8,17 +8,25 @@ module.exports = function (options) {
|
||||||
var opts = options ? clone(options) : {};
|
var opts = options ? clone(options) : {};
|
||||||
|
|
||||||
function nodeSass (file, cb) {
|
function nodeSass (file, cb) {
|
||||||
|
// file is on object passed in by gulp
|
||||||
|
// file.contents is always a Buffer
|
||||||
|
|
||||||
var newFile = clone(file);
|
var newFile = clone(file);
|
||||||
|
|
||||||
opts.data = newFile.contents.toString()
|
opts.data = newFile.contents.toString();
|
||||||
|
|
||||||
opts.success = function (css) {
|
opts.success = function (css) {
|
||||||
newFile.path = ext(newFile.path, '.css')
|
newFile.path = ext(newFile.path, '.css');
|
||||||
newFile.shortened = newFile.shortened && ext(newFile.shortened, '.css');
|
newFile.shortened = newFile.shortened && ext(newFile.shortened, '.css');
|
||||||
newFile.contents = new Buffer(css);
|
newFile.contents = new Buffer(css);
|
||||||
|
|
||||||
cb(null, newFile);
|
cb(null, newFile);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
opts.error = function (err) {
|
||||||
|
cb(err);
|
||||||
|
}
|
||||||
|
|
||||||
sass.render(opts);
|
sass.render(opts);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
{
|
{
|
||||||
"name": "gulp-sass",
|
"name": "gulp-sass",
|
||||||
"version": "0.2.0",
|
"version": "0.2.1",
|
||||||
"description": "Gulp plugin for sass",
|
"description": "Gulp plugin for sass",
|
||||||
"main": "index.js",
|
"main": "index.js",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
|
|
|
@ -3,5 +3,5 @@ var gulp = require('gulp')
|
||||||
;
|
;
|
||||||
|
|
||||||
gulp.src('./scss/*.scss')
|
gulp.src('./scss/*.scss')
|
||||||
.pipe(sass({outputStyle: 'compressed'}))
|
.pipe(sass())
|
||||||
.pipe(gulp.dest('./css/'));
|
.pipe(gulp.dest('./css/'));
|
Loading…
Reference in a new issue