metalsmith-relative

A metalsmith plugin which adds a function to the metadata to calculate relative paths.

Showing:

Popularity

Downloads/wk

272

GitHub Stars

9

Maintenance

Last Commit

7yrs ago

Contributors

1

Package

Dependencies

1

Size (min+gzip)

0.9KB

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

metalsmith-relative

A metalsmith plugin which adds a function to the metadata to calculate relative paths.

This is useful when you can't use absolute paths because you deploy to different context roots.

usage

Add the plugin to your build:

var relative = require('metalsmith-relative');
var opts = {
  methodName: 'relative'
};  // see options for further information

metalsmith.use(relative({ opts }));

Use it within your templates (for example within /foo/bar/baz.jade):

script(src=relative('/js/foobar.js'))

Results in:

<script src="../../js/foobar.js" />

options

methodName: Name of the method which will be injected into the metadata. Defaults to relative

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100