# metalsmith-stylus

> metalsmith stylus plugin

Latest version **3.0.0** (published 2017-02-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install metalsmith-stylus
pnpm add metalsmith-stylus
yarn add metalsmith-stylus
bun add metalsmith-stylus
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.0.0 |
| Published | 2017-02-02 |
| First published | 2014-04-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Erik Sundahl |
| Maintainers | esundahl |
| Keywords | metalsmith, stylus |

## Links

- npm: https://www.npmjs.com/package/metalsmith-stylus
- Repository: https://github.com/esundahl/metalsmith-stylus
- Issues: https://github.com/esundahl/metalsmith-stylus/issues
- npm.io page: https://npm.io/package/metalsmith-stylus

## Dependencies (2)

- [stylus](https://npm.io/package/stylus.md) ^0.54.5
- [minimatch](https://npm.io/package/minimatch.md) ^3.0.3

## Recent versions

- 3.0.0 (latest) — 2017-02-02
- 2.0.1 — 2016-10-27
- 2.0.0 — 2015-12-01
- 1.0.0 — 2015-08-10
- 0.2.2 — 2015-08-05
- 0.2.1 — 2014-07-19
- 0.2.0 — 2014-07-19
- 0.1.1 — 2014-04-02
- 0.1.0 — 2014-04-02

## README

metalsmith-stylus
===============
[![Build Status](https://travis-ci.org/esundahl/metalsmith-stylus.svg?branch=master)](https://travis-ci.org/esundahl/metalsmith-stylus)
[![Dependency Status](https://david-dm.org/esundahl/metalsmith-stylus.png)](https://david-dm.org/esundahl/metalsmith-stylus)

A [Stylus](http://learnboost.github.io/stylus/) plugin for Metalsmith.

## Installation

```sh
npm install --save metalsmith-stylus
```

## Getting Started

If you haven't checked out [Metalsmith](http://metalsmith.io/) before, head over to their website and check out the
documentation.

## CLI Usage

If you are using the command-line version of Metalsmith, you can install via npm, and then add the
`metalsmith-stylus` key to your `metalsmith.json` file:

```json
{
  "plugins": {
    "metalsmith-stylus": {}
  }
}
```

## JavaScript API

If you are using the JS Api for Metalsmith, then you can require the module and add it to your
`.use()` directives:

```js
var stylus = require('metalsmith-stylus');

metalsmith.use(stylus());
```

## Options

All option keys will be passed to stylus' [`set`](https://learnboost.github.io/stylus/docs/js.html#setsetting-value) method, except [`define`](https://learnboost.github.io/stylus/docs/js.html#definename-node) and [`use`](https://learnboost.github.io/stylus/docs/js.html#usefn).

To use stylus plug-ins like [nib](http://tj.github.io/nib/) or [autoprefixer](https://github.com/jenius/autoprefixer-stylus), add them as array to `use`:

```js
var stylus = require('metalsmith-stylus');
var nib = require('nib');

metalsmith.use(stylus({
	// Set stylus output to compressed
	compress: true,
	// Use the 'nib' plug-in
	use: [nib()],
	// Inline images as base64
	define: {
		url: stylus.url()
	}
}));
```

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