metalsmith-default-values

metalsmith-default-values

Metalsmith Plugin for setting default front-matter metadata.

Uses multimatch for pattern matching.

Installation

npm install -S metalsmith-default-values

Note: -S switch saves the plugin to your package.json.

Usage:

1. Include the plugin

const default_values = require('metalsmith-default-values');

2. Use the plugin in your build pipeline

...
.use(default_values([
  {
    pattern : 'posts/*.md',
    defaults: {
      layout: 'post.hbs'
    }
  },
  {
    pattern : 'diary/*.md',
    defaults: {
      layout : 'diary.hbs',
      private: true
    }
  },
  {
    pattern : [
      'diary/*.md',
      'archive/**/*.md'
    ],
    defaults: {
      no_index: true
    }
  },
  {
    pattern : '**/*.md',
    defaults: {
      layout : 'default.hbs'
    }
  }
]))
...

3. Profit

GL HF

Node versions

Because Joi > v6 uses ES6 syntax this runs on NodeJS v4 and above.

Contributions

Make sure you have EditorConfig plugin for your editor.

npm test runs the tests, also uses ESLint and Prettier

License - GPL-3.0

metalsmith-default-values is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

metalsmith-default-values is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with metalsmith-default-values. If not, see http://www.gnu.org/licenses/.

Changelog

v2.0.1

24 January 2018

• Dependencies: Updated Fixes #4 and general maintenance #8
• Merge pull request #8 from woodyrew/fix-dependencies #4
• Dependencies: Updated Fixes #4 and general maintenance #4 #7 #6 #3 #5
• Extra information and examples ae84ed0
• All the badges df8316f
• README: Formatting cfa537f
• Updated Dependencies 412293b
• Dependencies: Downgraded Joi to 12 for Node <6 compatibility 4df7f3c