Added documentation

dev
David Manning 2013-08-31 21:54:25 -07:00
parent c28845e17e
commit c7f4c33556
4 changed files with 39 additions and 7 deletions

View File

@ -1,4 +1,28 @@
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)

View File

@ -8,17 +8,25 @@ module.exports = function (options) {
var opts = options ? clone(options) : {};
function nodeSass (file, cb) {
// file is on object passed in by gulp
// file.contents is always a Buffer
var newFile = clone(file);
opts.data = newFile.contents.toString()
opts.data = newFile.contents.toString();
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.contents = new Buffer(css);
newFile.contents = new Buffer(css);
cb(null, newFile);
}
opts.error = function (err) {
cb(err);
}
sass.render(opts);
}

View File

@ -1,6 +1,6 @@
{
"name": "gulp-sass",
"version": "0.2.0",
"version": "0.2.1",
"description": "Gulp plugin for sass",
"main": "index.js",
"scripts": {

View File

@ -3,5 +3,5 @@ var gulp = require('gulp')
;
gulp.src('./scss/*.scss')
.pipe(sass({outputStyle: 'compressed'}))
.pipe(sass())
.pipe(gulp.dest('./css/'));