Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

docpad-plugin-sass

Package Overview
Dependencies
Maintainers
5
Versions
27
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

docpad-plugin-sass

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

  • 2.9.0
  • latest
  • Source
  • npm
  • Socket score

Version published
Maintainers
5
Created
Source

SASS/SCSS Plugin for DocPad with Compass support

Travis CI Build Status NPM version NPM downloads Dependency Status Dev Dependency Status
Patreon donate button Open Collective donate button Flattr donate button PayPal donate button Bitcoin donate button Wishlist browse button
Slack community badge

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). Make sure that you your files are located in documents (or render) folder as extensions-based rendering happens only inside this folder.

Install

  1. Install Ruby

  2. Install the SASS gem

  3. Optional: Install the Compass gem

  4. 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.

Sourcemaps

If you want to use sourcemaps, set the sourcemap option to true.

Bundlr Support

If you want to use bundler you can set something like this in docpad.coffee:

	plugins:
		sass:
			scssPath: ['bundle','exec','scss']
			sassPath: ['bundle','exec','sass']

Troubleshooting

I get ERROR: Cannot load compass.

Install compass again using: gem install compass --pre

History

Discover the release history by heading on over to the HISTORY.md file.

Contribute

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

Backers

Maintainers

These amazing people are maintaining this project:

Sponsors

No sponsors yet! Will you be the first?

Patreon donate button Open Collective donate button Flattr donate button PayPal donate button Bitcoin donate button Wishlist browse button

Contributors

These amazing people have contributed code to this project:

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

License

Unless stated otherwise all works are:

and licensed under:

Keywords

FAQs

Package last updated on 11 Jul 2018

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc