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