A Sass plugin for Metalsmith.
npm install --save metalsmith-sass
If you haven't checked out Metalsmith before, head over to their website and check out the documentation.
If you are using the command-line version of Metalsmith, you can install via npm, and then add the
metalsmith-sass key to your
If you are using the JS Api for Metalsmith, then you can require the module and add it to your
var sass = ;metalsmith;
See node-sass for a complete list of supported options.
In addition to the options that node-sass provides, metalsmith-sass provides the following options:
Change the base folder path styles are outputed to. You can use this in combination with
destination option to control where styles end up after the build.
The final output directory is equal to
Metalsmith.destination() + outputDirOption. For example,
the following setup output styles to
build/css/ even though the source files are in
As of version v1.1, you can also use a function to dynamically manipulate the output dir.
This is useful if you want to preserve your folder structure, but change just one folder name.
The easiest way to enable source maps in your metalsmith project is to add the following options:
sourceMapContents is not required, I recommend adding it, otherwise you'll need to
manually serve up your
.scss files along with your compiled
.css files when you publish your
As of version v1.2,
metalsmith-sass automatically handles
.sass files, so you don't need to specify the
option. Though you might still need set options for
indentWidth if you are
using something other than 2 spaces for indentation.