Skip to content

Latest commit

 

History

History
90 lines (59 loc) · 1.44 KB

README.md

File metadata and controls

90 lines (59 loc) · 1.44 KB

metalsmith-stylus

build status

A Stylus plugin for Metalsmith.

Installation

npm install metalsmith-styl

Usage

//Without params
var stylus = require('metalsmith-stylus')

Metalsmith(__dirname)
  .use(stylus())
  .build()

//With params
var stylus = require('metalsmith-stylus')

Metalsmith(__dirname)
  .use(stylus({
    master: 'master.styl',
    output: 'app.css',
    filter: '.styl, .stylus, .test'
  }))
  .build()

//With outputDir
var stylus = require('metalsmith-stylus')

Metalsmith(__dirname)
  .use(stylus({
    master: 'master.styl',
    outputDir: '.'
  }))
  .build()

Options

Use any or all of the following:

filter

Extensions that need to be processed

default: .styl, .stylus

master

Name of the master file. File included in this one will not be rendered.

default: null

outputDir

Name of the folder in your build.

default: null (keep the same architecture)

output

Name of the file in your build. Use only if master is specified.

default: null

Todo

Tests

$ mocha

License

MIT License, see LICENSE for details.