@fidian/metalsmith-less
Version:
A LESS plugin for Metalsmith
58 lines (34 loc) • 1.72 kB
Markdown
# metalsmith-less
[](https://travis-ci.org/christophercliff/metalsmith-less)
A [LESS](http://lesscss.org/) plugin for [Metalsmith](http://www.metalsmith.io/).
## Installation
```
npm install @fidian/metalsmith-less
```
## Usage
```js
var less = require('@fidian/metalsmith-less')
new Metalsmith(__dirname)
.use(less(options))
.build()
```
### **`options`** `Object`
- **`pattern`** `String|Array<String>`
The [pattern](https://github.com/sindresorhus/multimatch) to filter source files. Default `**/*.less`.
- **`removeSource`** `Boolean`
When `true`, the source files are removed and will not appear in the `build/` directory. The default is `false`, which will keep a copy of your `*.less` files around.
- **`render`** `Object`
The options passed to [`less.render(String[, Object])`](http://lesscss.org/usage/#programmatic-usage). Unfortunately, this method is *undocumented*. See https://github.com/less/less-docs/issues/212 for more information. Default `undefined`.
- **`useDynamicSourceMap`** `Boolean`
Overrides the supplied source map configuration with a dynamic file-level configuration. This is the easiest way to enable source maps in your Metalsmith build. Default `false`.
## Tests
```
$ npm test
```
## Credits and License
This is a fork of [metalsmith-less](https://github.com/christophercliff/metalsmith-less/) and is published as `@fidian/metalsmith-less`.
Changes from original:
* Removed style check to eliminate problems reported via `npm audit`.
* Updated packages.
* Includes the `removeSource` option.
MIT License, see [LICENSE](LICENSE.md) for details.