Awesome

<h1>docpad-plugin-nodesass</h1>

Adds support for the SCSS CSS pre-processor to DocPad.

The indented .sass syntax is not supported by node-sass, so it is not supported by this plugin.

Convention: .css.scss

Output Style

outputStyle: 'nested'|'compressed'

outputStyle is a String to determine how the final CSS should be rendered. Its value should be one of 'nested' or 'compressed'. 'expanded' and 'compact' are not currently supported by libsass.

Options

An object that you can use to pass options to node-sass

Debug Info

debugInfo: false|'normal'|'map'

normal will print comments in the output css that indicates the source file name and line number. map will produce a sourcemap. Using either of these options instead of none will prevent you from being able to run any other process on the file (e.g. FILE.css.scss.eco), because debugInfo requires passing an actual file instead of stdin.

Render Underscore Stylesheets

renderUnderscoreStylesheets: false|true

By default we prevent any SCSS stylesheets that filename starts with underscore character from being rendered and written to the output directory. This is to follow SCSS convention that such files are just intended to be included inside our 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.

import-once example

The node-sass-import-once module speeds up rendering by only importing files once. It also adds a few additional features including automatically importing from bower_components/.

Install it with

npm install --save node-sass-import-once

And then configure it by setting the nodesass.options.importer to the import-once module:

    plugins:
        nodesass:
            options:
                importer: require('node-sass-import-once')
                importOnce:
                    index: true # @import 'foo'; will load foo/_index.scss if foo is a folder
                    css: true # @import 'bar'; will import bar.css
                    bower: true # automatically search bower_components directory for imports

Bourbon example

The node-bourbon module includes a simple and lightweight mixin library.

Install it with

npm install --save node-bourbon

And then configure it by setting nodesass.options.includePaths to the includePaths provided by the module.

    plugins:
        nodesass:
            options:
                includePaths: require('node-bourbon').includePaths

<h2>Install</h2>

Install this DocPad plugin by entering <code>docpad install nodesass</code> into your terminal.

<h2>History</h2>

<a href="https://github.com/docpad/docpad-plugin-nodesass/blob/master/HISTORY.md#files">Discover the release history by heading on over to the <code>HISTORY.md</code> file.</a>

<h2>Contribute</h2>

<a href="https://github.com/docpad/docpad-plugin-nodesass/blob/master/CONTRIBUTING.md#files">Discover how you can contribute by heading on over to the <code>CONTRIBUTING.md</code> file.</a>

<h2>Backers</h2> <h3>Maintainers</h3>

These amazing people are maintaining this project:

<ul><li><a href="10x.la/croixdrinker">Jimmy King</a> — <a href="https://github.com/docpad/docpad-plugin-nodesass/commits?author=10xLaCroixDrinker" title="View the GitHub contributions of Jimmy King on repository docpad/docpad-plugin-nodesass">view contributions</a></li></ul> <h3>Sponsors</h3>

No sponsors yet! Will you be the first?

<h3>Contributors</h3>

These amazing people have contributed code to this project:

<ul><li><a href="https://github.com/balupton">Benjamin Lupton</a> — <a href="https://github.com/docpad/docpad-plugin-nodesass/commits?author=balupton" title="View the GitHub contributions of Benjamin Lupton on repository docpad/docpad-plugin-nodesass">view contributions</a></li> <li><a href="https://github.com/chrishale">Chris Hale</a> — <a href="https://github.com/docpad/docpad-plugin-nodesass/commits?author=chrishale" title="View the GitHub contributions of Chris Hale on repository docpad/docpad-plugin-nodesass">view contributions</a></li> <li><a href="https://github.com/greenkeeperio-bot">Greenkeeper</a> — <a href="https://github.com/docpad/docpad-plugin-nodesass/commits?author=greenkeeperio-bot" title="View the GitHub contributions of Greenkeeper on repository docpad/docpad-plugin-nodesass">view contributions</a></li> <li><a href="https://github.com/jankolkmeier">Jan Kolkmeier</a> — <a href="https://github.com/docpad/docpad-plugin-nodesass/commits?author=jankolkmeier" title="View the GitHub contributions of Jan Kolkmeier on repository docpad/docpad-plugin-nodesass">view contributions</a></li> <li><a href="10x.la/croixdrinker">Jimmy King</a> — <a href="https://github.com/docpad/docpad-plugin-nodesass/commits?author=10xLaCroixDrinker" title="View the GitHub contributions of Jimmy King on repository docpad/docpad-plugin-nodesass">view contributions</a></li> <li><a href="https://github.com/johannestroeger">Johannes Troeger</a> — <a href="https://github.com/docpad/docpad-plugin-nodesass/commits?author=johannestroeger" title="View the GitHub contributions of Johannes Troeger on repository docpad/docpad-plugin-nodesass">view contributions</a></li> <li><a href="https://github.com/iammerrick">Merrick Christensen</a> — <a href="https://github.com/docpad/docpad-plugin-nodesass/commits?author=iammerrick" title="View the GitHub contributions of Merrick Christensen on repository docpad/docpad-plugin-nodesass">view contributions</a></li> <li><a href="https://github.com/barlock">Michael Barlock</a> — <a href="https://github.com/docpad/docpad-plugin-nodesass/commits?author=barlock" title="View the GitHub contributions of Michael Barlock on repository docpad/docpad-plugin-nodesass">view contributions</a></li> <li><a href="https://github.com/mikeumus">Michael Duane Mooring</a> — <a href="https://github.com/docpad/docpad-plugin-nodesass/commits?author=mikeumus" title="View the GitHub contributions of Michael Duane Mooring on repository docpad/docpad-plugin-nodesass">view contributions</a></li> <li><a href="https://github.com/nfriedly">Nathan Friedly</a> — <a href="https://github.com/docpad/docpad-plugin-nodesass/commits?author=nfriedly" title="View the GitHub contributions of Nathan Friedly on repository docpad/docpad-plugin-nodesass">view contributions</a></li> <li><a href="https://github.com/thuongdinh">Thuong Dinh</a> — <a href="https://github.com/docpad/docpad-plugin-nodesass/commits?author=thuongdinh" title="View the GitHub contributions of Thuong Dinh on repository docpad/docpad-plugin-nodesass">view contributions</a></li> <li><a href="https://github.com/0x6a68">x6a68</a> — <a href="https://github.com/docpad/docpad-plugin-nodesass/commits?author=0x6a68" title="View the GitHub contributions of x6a68 on repository docpad/docpad-plugin-nodesass">view contributions</a></li></ul>

<a href="https://github.com/docpad/docpad-plugin-nodesass/blob/master/CONTRIBUTING.md#files">Discover how you can contribute by heading on over to the <code>CONTRIBUTING.md</code> file.</a>

<h2>License</h2>

Unless stated otherwise all works are:

and licensed under:

<ul><li><a href="http://spdx.org/licenses/MIT.html">MIT License</a></li></ul>