philipp90 / metalsmith-assets

Include static assets in your Metalsmith build

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

metalsmith-assets

Include static assets in your Metalsmith build

Installation

$ npm install metalsmith-assets

CLI Usage

Install via npm and then add the metalsmith-assets key to your metalsmith.json plugins with a source and destination directory, like so:

{
  "plugins": {
    "metalsmith-assets": {
      "source": "./assets",
      "destination": "./assets"
    }
  }
}
  • source defaults to './public'
  • destination defaults to '.'

Javascript Usage

Pass options to the assets plugin and pass it to Metalsmith with the use method:

var assets = require('metalsmith-assets');

metalsmith.use(assets({
  source: './assets', // relative to the working directory
  destination: './assets', // relative to the build directory
  skip: true  // optional (default: false) skip/do not copy already existing files
}));

License

MIT

About

Include static assets in your Metalsmith build


Languages

Language:JavaScript 95.0%Language:Makefile 5.0%