A Metalsmith plugin to compile assets with Duo
JavaScript Makefile
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
test Ignore nonexistent entry points Aug 14, 2015
.editorconfig
.gitignore Add options and plugins parameters, and test all features Aug 9, 2015
LICENSE
Makefile
README.md
package.json bumb to version 0.1.1 Aug 16, 2015

README.md

NPM version

A Metalsmith plugin to compile your assets with Duo.js

Installation

In a Metalsmith project just install metalsmith-duo straight from npm with:

$ npm install --save metalsmith-duo

Duo requires you to authenticate with GitHub to increase your rate limit and allow you to pull from private repositories. To do that, add the following entry to your ~/.netrc file:

machine api.github.com
  login <username>
  password <token>

You can create a new token here: https://github.com/settings/tokens/new

CLI Usage

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

{
  "plugins": {
    "metalsmith-duo": {}
  }
}

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 duo = require('metalsmith-duo');

metalsmith.use(duo());

OPTIONS

entry

This plugin requires you to specify at least a single entry point. Entry points are relative to the source directory. Entry points are passed as an array. So:

{
  "plugins": {
    "metalsmith-duo": {
      "entry": ["css/index.css", "js/index.js"]
    }
  }
}

Will process src/css/index.css and src/js/index.js.

plugins

You can pass plugins to Duo with the plugins key. So for example:

var Metalsmith = require('metalsmith');
var duo = require('metalsmith-duo');
var autoprefixer = require('duo-autoprefixer');

Metalsmith()
  .use(duo({
    entry: ['index.css'],
    plugins: [
      autoprefixer()
    ]
  }))

Will allow duo to use the duo-autoprefixer plugin. See the Duo plugins for a list of available plugins.

options

You can pass options to Duo with the options key. So for example:

var Metalsmith = require('metalsmith');
var duo = require('metalsmith-duo');

Metalsmith()
  .use(duo({
    entry: ['index.js'],
    options: {
      development: true
    }
  }))

Will set Duo to development mode. See the Duo API docs for all available options.

Authors

License

The MIT License

Copyright © 2014

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.