metalsmith-path
Adds 'path' property to each file's metadata, which can be used as a URL.
Installation
$ npm i -S metalsmith-path
CLI Usage
Install via npm and then add the metalsmith-path
key to your metalsmith.json
plugins, like so:
Javascript Usage
Pass the plugin to Metalsmith#use
:
const path = metalsmith
Available options
property
The name of the property (key) where the path will be stored. Default: path
.
Example:
metalsmith
baseDirectory
The baseDirectory
of the site, useful for generating absolute paths. Default:
empty.
Example:
metalsmith
directoryIndex
If a directoryIndex
is supplied, it will be stripped from the path. Default:
disabled.
Example:
metalsmith
This creates URLs such as /blog
instead of /blog/index.html
.
extensions
If the file's extension isn't found in the provided array then it will be
ignored by the plugin. Default: ['.html']
Example:
metalsmith
License
WTFPL