Install via metalsmith-plugin-template/index.js

metalsmith-plugin-template.js

/**
 * @file Plugin template.
 *
 * @example
 * var myPlugin = require('./plugins/my-plugin');
 * Metalsmith(__dirname)
 *   .source('./src')
 *   .destination('./build')
 *   .use(myPlugin())
 *   .build(function(err) {});
 */

/**
* @param {object} options
*/
module.exports = function (options) {

  /**
   * Manipulate loaded src file data.
   *
   * @param {object} data
   * @param {object} options
   */
  function myPlugin (data, options) {

  }


 /**
  * Operate on each file.
  *
  * @param {object} files
  * @param {Metalsmith} metalsmith
  * @param {function} done
  */
  return function pluginFileWalk(files, metalsmith, done) {
    setImmediate(done);
    Object.keys(files).forEach(function(file) {
      myPlugin(files[file], options);
    });
  };
};