metalsmith-stylus

A Stylus plugin for Metalsmith.

Installation

npm install --save metalsmith-stylus

Getting Started

If you haven't checked out Metalsmith 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:

{
  "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:

var stylus = require('metalsmith-stylus');
 
metalsmith.use(stylus());

Options

All option keys will be passed to stylus' set method, except define and use.

To use stylus plug-ins like nib or autoprefixer, add them as array to use:

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()
    }
}));