@mike-north/metalsmith-drafts
v1.0.1
Published
A metalsmith plugin to hide drafts.
Downloads
15
Keywords
Readme
Metalsmith Drafts
A metalsmith plugin to hide drafts.
Installation
$ npm install metalsmith-drafts
CLI Usage
Install via npm and then add the metalsmith-drafts
key to your metalsmith.json
plugins, like so:
{
"plugins": {
"metalsmith-drafts": true
}
}
Then in your files YAML front-matter add draft: true
.
In case you want to force all files to be set to draft: true
, use the following plugin-option:
{
"plugins": {
"metalsmith-drafts": {
"default": true
}
}
}
Javascript Usage
Pass the plugin to Metalsmith#use
, like so:
var drafts = require('metalsmith-drafts');
metalsmith.use(drafts());
Then in your files YAML front-matter add draft: true
.
Default value for draft
If you want to define a default value for draft
(in case they are not definied in the YAML front-matter, then use the plugin option default
:
var drafts = require('metalsmith-drafts');
metalsmith.use(drafts( {
default: true
}));
License
MIT