Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

docpad-plugin-nodesass

Travis CI Build Status NPM version NPM downloads Dependency Status Dev Dependency Status
GitHub Sponsors donate button Patreon donate button Flattr donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal donate button Wishlist browse button

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

Install

Install this DocPad plugin by entering docpad install nodesass into your terminal.

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?

GitHub Sponsors donate button Patreon donate button Flattr donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal 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: