0.1.0 • Published 7 years ago

metalsmith-packages v0.1.0

Weekly downloads
2
License
MIT
Repository
github
Last release
7 years ago

metalsmith-packages

Version Build Status

A metalsmith plugin to add folders or files from outside the source directory with the idea to evolve into a content package system.

Installation

$ npm install metalsmith-packages

CLI Usage

Install via npm and then add the metalsmith-packages key to your metalsmith.json plugins, like so:

{
  "plugins": {
    "metalsmith-packages": {
      "paths": {}, // Not implemented yet.
      "key": "folder"
    }
  }
}

The key option will look for this key in the global metadata object for instance

{
  "folder": {
    "things": "~/some/path"
  }
}

The key object contains a mapping of the destination path (here things) where the absolute target path (here ~/some/path) will be mounted.

Note that ~ will be expanded to the user's home dir.

TODO:

  • Think about how to make this into a module system alongside the transclusion plugins.

License

MIT