metalsmith rework plugin
JavaScript
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
test
.gitignore
Readme.md
package.json

Readme.md

metalsmith-rework

An rework plugin for Metalsmith.

Installation

npm install --save metalsmith-rework

Getting Started

If you haven't checked out Metalsmith before, head over to their website and check out the documentation.

In order to use this plugin, you need to include the rework module in your package.json file:

{
  ...
  "dependencies": {
    ...
    "rework": "*"
  }
  
}

CLI Usage

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

{
  "plugins": {
    "metalsmith-rework": {}
  }
}

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

metalsmith.use(reworkPlugin({
    configure: (rework, filePath) => { 
      var directory =  path.dirname(filePath)
     
      return rework.use(reworkPlugin())}
    )}))

Options

None yet