A plugin that adds Sass support to Eleventy
Available on npm.
npm install eleventy-plugin-sass --save
Open up your Eleventy config file (probably .eleventy.js) and use addPlugin:
const pluginSass = require("eleventy-plugin-sass");
module.exports = function(eleventyConfig) {
eleventyConfig.addPlugin(pluginSass, sassPluginOptions);
};
Read more about Eleventy plugins.
| Key | Type | Default | description |
|---|---|---|---|
watch |
glob or array of globs | ['**/*.{scss,sass}', '!node_modules/**'] |
The sass files you wish to compile (and watch when you serve) |
sourcemaps |
Boolean | false |
Add sourcemaps next to your sass files |
cleanCSS |
Boolean | true |
Runs the css trough cleanCSS |
cleanCSSOptions |
Object | N/A |
Options to pass to cleanCSS |
autoprefixer |
Boolean | true |
Adds browser specific prefixes if needed (adheres to BrowserList) |
outputDir |
String | undefined | specifies the desired output directory |
remap |
Boolean | false | toggles the way EPS handles the output or better omits the path-part of each parsed file, so that you might get a slightly cleaner output |
compiler |
Object | require('sass') |
Allows you to override the default compiler used (currently node-sass). For example: Add node-sass to your package.json and then specify require('node-sass') to use the now dreprecated node-sass compiler instead. |
sassOptions |
Object | N/A |
Options you want to pass to the specified sass compiler (see above). |
This plugins wraps around internal Eleventy code, so if they changes their way of working it might stop working.
Please do contribute, I am open to any changes. Just clone the repository and open a pull request.
MIT © Maarten Schroeven