This package has been deprecated

Author message:

This package is no longer maintained and has moved to the @metalsmith org; Please migrate to the following package: @metalsmith/remove

metalsmith-ignore

A Metalsmith plugin to ignore files that match a pattern. Uses multimatch for matching.

Installation

$ npm install metalsmith-ignore

CLI Usage

Install via npm and then add the metalsmith-ignore key to your metalsmith.json plugins. The simplest case just ignores a single pattern:

{
  "plugins": {
    "metalsmith-ignore": "drafts/*"
  }
}

But you can also pass an array of patterns to ignore:

{
  "plugins": {
    "metalsmith-ignore": [
      "drafts/*",
      "unfinished/*"
    ]
  }
}

Javascript Usage

Pass the options to Metalsmith#use:

var ignore = require('metalsmith-ignore');
 
metalsmith.use(ignore('drafts/*'));

You can also pass an array of patterns to ignore:

var ignore = require('metalsmith-ignore');
 
metalsmith.use(ignore([
  'drafts/*',
  'unfinished/*'
]));

License

MIT