Node-sass is a library that provides binding for Node.js to libsass, the C version of the popular stylesheet preprocessor, Sass.
Node-sass is a library that provides binding for Node.js to libsass, the C version of the popular stylesheet preprocessor, Sass.
It allows you to natively compile .scss files to css at incredible speed and automatically via a connect middleware.
Find it on npm: https://npmjs.org/package/node-sass
Install
npm install node-sass
Usage
var sass = require('node-sass');
sass.render({
file: scss_filename,
success: callback
[, options..]
});
// OR
var css = sass.renderSync({
data: scss_content
[, options..]
});
Options
The API for using node-sass has changed, so that now there is only one variable - an options hash. Some of these options are optional, and in some circumstances some are mandatory. file
file
is a String of the path to an scss file for libsass to render. One of this or data options are required, for both render and renderSync.
data
data
is a String containing the scss to be rendered by libsass. One of this or file options are required, for both render and renderSync. It is recommended that you use the includePaths option in conjunction with this, as otherwise libsass may have trouble finding files imported via the @import directive.
success
success
is a Function to be called upon successful rendering of the scss to css. This option is required but only for the render function. If provided to renderSync
it will be ignored.
error
error
is a Function to be called upon occurrence of an error when rendering the scss to css. This option is optional, and only applies to the render function. If provided to renderSync
it will be ignored.
includePaths
includePaths
is an Array of path Strings to look for any @imported files. It is recommended that you use this option if you are using the data option and have any @import
directives, as otherwise libsass may not find your depended-on files.
imagePath
imagePath
is a String that represents the public image path. When using the image-url()
function in a stylesheet, this path will be prepended to the path you supply. eg. Given an imagePath
of /path/to/images
, background-image: image-url('image.png')
will compile to background-image: url("/path/to/images/image.png")
outputStyle
outputStyle
is a String to determine how the final CSS should be rendered. Its value should be one of 'nested'
, 'expanded'
, 'compact'
, 'compressed'
. [Important: currently the argument outputStyle
has some problem which may cause the output css becomes nothing because of the libsass, so you should not use it now!]
sourceComments
sourceComments
is a String to determine what debug information is included in the output file. Its value should be one of 'none'
, 'normal'
, 'map'
. The default is 'none'
. The map option will create the source map file in your CSS destination. [Important: souceComments
is only supported when using the file option, and does nothing when using data
flag.]
sourceMap
If your sourceComments
option is set to map, sourceMap
allows setting a new path context for the referenced Sass files. The source map describes a path from your CSS file location, into the the folder where the Sass files are located. In most occasions this will work out-of-the-box but, in some cases, you may need to set a different output.
More information: https://github.com/andrew/node-sass