Assemble pipeline plugin for pushing views into a vinyl stream.
Install with npm:
$ npm install --save assemble-streams
This plugin can be used with assemble, verb or any other application based on templates.
var assemble = require('assemble');
var streams = require('assemble-streams');
// create your application
var app = assemble();
// register the plugin
app.use(streams());
// use the plugin on app
app.toStream('pages')
.pipe(app.dest('site/'));
// use the plugin on a collection
app.pages.toStream()
.pipe(app.dest('site/'));
// use the plugin on a view
app.pages.getView('home').toStream()
.pipe(app.dest('site/'));
See the tests for more examples.
Push a view collection into a vinyl stream.
Params
collection
{String}: Name of the collection to push into the stream.- {Function}: Optionally pass a filter function to use for filtering views.
returns
{Stream}
Example
app.toStream('posts', function(file) {
return file.path !== 'index.hbs';
})
Push a view collection into a vinyl stream.
Params
- {Function}: Optionally pass a filter function to use for filtering views.
returns
{Stream}
Example
app.posts.toStream(function(file) {
return file.path !== 'index.hbs';
})
Push the current view into a vinyl stream.
returns
{Stream}
Example
app.pages.getView('a.html').toStream()
.on('data', function(file) {
console.log(file);
//=> <Page "a.html" <Buffer 2e 2e 2e>>
});
- assemble-loader: Assemble plugin (^0.6.0) for loading globs of views onto custom view collections. Also works with… more | homepage
- assemble-render-file: Assemble plugin for rendering views in a vinyl pipeline. | homepage
- assemble: Get the rocks out of your socks! Assemble makes you fast at creating web projects… more | homepage
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Commits | Contributor |
---|---|
34 | jonschlinkert |
21 | doowb |
(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)
To generate the readme, run the following command:
$ npm install -g verbose/verb#dev verb-generate-readme && verb
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
$ npm install && npm test
Jon Schlinkert
Copyright © 2017, Jon Schlinkert. MIT
This file was generated by verb-generate-readme, v0.4.2, on February 11, 2017.