metalsmith-transclude-transform

A metalsmith plugin to transform content before transclusion with metalsmith-transclude

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
metalsmith-transclude-transform
0.1.116 years ago7 years agoMinified + gzip package size for metalsmith-transclude-transform in KB

Readme

metalsmith-transclude-transform
Version Build Status
A metalsmith plugin to transform content before transclusion with metalsmith-transclude.

Installation

$ npm install metalsmith-transclude

CLI Usage

Install via npm and then add the metalsmith-tranclude key to your metalsmith.json plugins, like so:
{
  "plugins": {
    "metalsmith-transclude-transform": {
      "permalinks": true,
      "folders": true
    }
  }
}

The permalinks option will transform transclusion links of the form:
:[](include/file)

if the destination file exists into:
:[](include/file.md)

The folders option will transform transclusion links of the form:
:[](include)

if the destination folder exists and is non empty (in this example the include folder contains files file1.md and file2.md to:
:[](include/file1.md)
:[](include/file2.md)

License

MIT