Package Exports

docpad-plugin-sass

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (docpad-plugin-sass) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

SASS/SCSS Plugin for DocPad with Compass support

Adds support for the SASS and SCSS CSS pre-processors to DocPad. It also supports the Compass framework.

This SASS/SCSS plugin uses the original ruby implementation, which requires installing ruby and the necessary gems. If you would like to use a native node implementation which would be faster (but no support for 3rd party ruby gems like compass etc) then we'd recommend using the nodesass plugin. More info here.

Convention: .css.(sass|scss)

Install

Install Ruby
Install the SASS gem
Optional: Install the Compass gem
Install this plugin
```
docpad install sass
```

Configure

For information on customising your plugin configuration you can refer to the DocPad FAQ

Sass and Scss Paths

We automatically detect the path to your sass and scss executables, however sometimes that doesn't work and you will get ENOENT errors. If our detection fails and you'll have to manually specify the path to your sass and scss executables with the sassPath and scssPath config options, more info here.

Compass Support

We automatically detect if you have compass installed, and if you do, then we'll use it. If our detection fails and you want to still use it, then set the compass option to true. If you have compass installed but don't want to use it then set the compass option to false.

Output Style

You can set the outputStyle option to any of the supported output styles. Those being nested, expanded, compact, and compressed. By default, we use the compressed mode for all environments, except the development mode where it is set to expanded.

Require Libraries

You can set the requireLibraries option to an array of extra ruby libraries you'd like to include before rendering your sass file. For instance, setting it to ['susy','compass-colors'] will include the Susy and Compass Colors plugins. By default, the value is set to null indicating we do not include any libaries.

Render Underscore Stylesheets

By default we prevent any SASS/SCSS stylesheets that filename starts with underscore character from being rendered and written to the output directory. This is to follow SASS/SCSS convention that such files are just intended to be included inside out stylesheets, and that they are not meant to be rendered by themselves. If you really want to, you can render the underscore stylesheets by setting the renderUnderscoreStylesheets option to true in your plugin's configuration.

History

You can discover the history inside the History.md file

Contributing

You can discover the contributing instructions inside the Contributing.md file

docpad-plugin-sass