metalsmith-slug

metalsmith slug

Add a slug property to the metadata for targeted files in your Metalsmith, based on a particular property. Useful for generating links to pages based on, say, their title.

Installation

npm install metalsmith-slug

Usage

If you're not familiar with Metalsmith, check it out. It's a very versatile file processor that can be used for static site generation, project scaffolding and more.

Metalsmith CLI

Add metalsmith-slug to your metalsmith.json.

{
  "plugins": {
    "metalsmith-slug": {}
  }
}

Metalsmith JavaScript API

Add metalsmith-slug to your project and .use() it.

var slug = require('metalsmith-slug');

metalsmith.use(slug());

Options

patterns [array]: Glob patters of files to match. Uses minimatch.

metalsmith.use(slug({
  patterns: ['*.md', '*.rst'] // Deafults to metalsmith.source() directory
}));

property 'string': Property to generate the slug from.

metalsmith.use(slug({
  property: 'name' // Defaults to 'title'
}));

renameFiles boolean: When set to true, will rename the files passed to metalsmith-slug to the file's new slug property.

metalsmith.use(slug({
  renameFiles: true
}));

slug options: You can additionally use any of the options available to node-slug

metalsmith.use(slug({
  replacement: '_', // Defaults to node-slug defaults
  symbols: false
}));