An open API service indexing awesome lists of open source software.

https://github.com/doowb/assemble-metalsmith

Assemble v0.6.x plugin for running any metalsmith middlewares
https://github.com/doowb/assemble-metalsmith

Last synced: 6 months ago
JSON representation

Assemble v0.6.x plugin for running any metalsmith middlewares

Awesome Lists containing this project

README

          

# assemble-metalsmith [![NPM version](https://badge.fury.io/js/assemble-metalsmith.png)](http://badge.fury.io/js/assemble-metalsmith)

> Assemble v0.6.x plugin for running any metalsmith middlewares

## IMPORTANT! This plugin only works with [Assemble v0.6](https://github.com/assemble/assemble/tree/v0.6.0) and greater.

## Install
#### Install with [npm](npmjs.org):

```bash
npm i assemble-metalsmith --save-dev
```

## Usage

```js
var metalsmith = require('assemble-metalsmith')(assemble);
metalsmith
.use(drafts())
.use(markdown())
.use(permalinks('posts/:title'))
.use(templates('handlebars'));

assemble.src('path/to/pages/*.hbs')
.pipe(metalsmith())
.pipe(assemble.dest('dist'));
```

## API
### Metalsmith plugin

Assemble plugin to run metalsmith middleware

### .use

Add a middleware or plugin to use.

* `middleware` {Function}: this is the middleware to run.
* `return` {Object} this for chaining

## Author

**Brian Woodward**

+ [github/doowb](https://github.com/doowb)
+ [twitter/doowb](http://twitter.com/doowb)

## License
Copyright (c) 2014 Brian Woodward, contributors.
Released under the MIT license

***

_This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on August 03, 2014._