# eleventy-plugin-sass

> A plugin for sass support in Eleventy

Latest version **1.2.0** (published 2021-03-02) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install eleventy-plugin-sass
pnpm add eleventy-plugin-sass
yarn add eleventy-plugin-sass
bun add eleventy-plugin-sass
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.2.0 |
| Published | 2021-03-02 |
| First published | 2019-10-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 10 |
| Unpacked size | 9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 31 |
| Author | Maarten Schroeven |
| Maintainers | sonaryr |
| Keywords | eleventy, eleventy-plugin, sass, scss |

## Links

- npm: https://www.npmjs.com/package/eleventy-plugin-sass
- Repository: https://github.com/Sonaryr/eleventy-plugin-sass
- Issues: https://github.com/Sonaryr/eleventy-plugin-sass/issues
- npm.io page: https://npm.io/package/eleventy-plugin-sass

## Dependencies (10)

- [chalk](https://npm.io/package/chalk.md) ^2.4.2
- [gulp-if](https://npm.io/package/gulp-if.md) ^3.0.0
- [chokidar](https://npm.io/package/chokidar.md) ^3.2.1
- [vinyl-fs](https://npm.io/package/vinyl-fs.md) ^3.0.3
- [gulp-sass](https://npm.io/package/gulp-sass.md) ^4.0.2
- [map-stream](https://npm.io/package/map-stream.md) ^0.0.7
- [gulp-clean-css](https://npm.io/package/gulp-clean-css.md) ^4.2.0
- [gulp-sourcemaps](https://npm.io/package/gulp-sourcemaps.md) ^2.6.5
- [lodash.debounce](https://npm.io/package/lodash.debounce.md) ^4.0.8
- [gulp-autoprefixer](https://npm.io/package/gulp-autoprefixer.md) ^7.0.1

## Alternatives

- [async-exit-hook](https://npm.io/package/async-exit-hook.md) — 3.7M weekly downloads
- [evnty](https://npm.io/package/evnty.md) — 7.2K weekly downloads
- [eleventy-plugin-asciidoc](https://npm.io/package/eleventy-plugin-asciidoc.md) — 3.5K weekly downloads
- [@jswork/next-get2get](https://npm.io/package/@jswork/next-get2get.md) — 945 weekly downloads
- [@dashersw/axon](https://npm.io/package/@dashersw/axon.md) — 934 weekly downloads

## Recent versions

- 1.2.0 (latest) — 2021-03-02
- 1.1.1 — 2020-09-10
- 1.1.0 — 2020-09-08
- 1.0.0 — 2019-10-09

## README

# eleventy-plugin-sass

A plugin that adds [Sass](https://sass-lang.com/) support to [Eleventy](https://github.com/11ty/eleventy)

## Installation

Available on [npm](https://www.npmjs.com/package/eleventy-plugin-sass).

```
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.](https://www.11ty.io/docs/plugins/)

## Options

| 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](https://github.com/jakubpawlowicz/clean-css)                                       |
| `cleanCSSOptions` | Object                 | `N/A`                                      | Options to pass to cleanCSS                                                                                       |
| `autoprefixer`    | Boolean                | `true`                                     | Adds browser specific prefixes if needed (adheres to [BrowserList](https://github.com/browserslist/browserslist)) |
| `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 |
| `sassOptions`     | Object                 | `N/A`                                      | Options you want to pass to [node-sass](https://github.com/sass/node-sass#options) |

## Disclaimer

This plugins wraps around internal Eleventy code, so if they changes their way of working it might stop working.

## Contributing

Please do contribute, I am open to any changes. Just clone the repository and open a pull request.

## License

MIT © [Maarten Schroeven](maarten@sonaryr.be)

---
_Source: https://npm.io/package/eleventy-plugin-sass · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._