metalsmith-drafts
A metalsmith plugin to hide drafts.
Last updated 9 months ago by woodyrew .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install metalsmith-drafts 
SYNC missed versions from official npm registry.

Metalsmith Drafts

npm version code style: prettier metalsmith: plugin

Build Status

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

Current Tags

  • 1.0.0                                ...           latest (9 months ago)

3 Versions

  • 1.0.0                                ...           9 months ago
  • 0.1.0                                ...           2 years ago
  • 0.0.1                                ...           7 years ago

Copyright 2014 - 2016 © taobao.org |