Wraps templates with layouts. Layouts can use other layouts and be nested to any depth. This can be used 100% standalone to wrap any kind of file with banners, headers or footer content. Use for markdown, HTML, handlebars views, lo-dash templates, etc. La
npm install layouts> Wraps templates with layouts. Layouts can use other layouts and be nested to any depth. This can be used 100% standalone to wrap any kind of file with banners, headers or footer content. Use for markdown, HTML, handlebars views, lo-dash templates, etc. Layouts can also be vinyl files.
Please consider following this project's author, Brian Woodward, and consider starring the project to show your :heart: and support.
Install with npm:
``sh`
$ npm install --save layouts
`js
const renderLayouts = require('layouts');
renderLayouts(file, layoutCollection, options);
`
* file - a file object (or vinyl file) with a file.contents property that must be a bufferlayoutCollection
* - an object of file objects to use as layoutsoptions
* - see available options
This library does not clone the file object. If you want to prevent file.contents from being mutated (after rendering layouts), clone the file first before passing it to this library.
`js
const renderLayouts = require('layouts');
const file = {
contents: Buffer.from('
const layoutCollection = {
one: { contents: Buffer.from('one before\n{% body %}\none after'), layout: 'two' },
two: { contents: Buffer.from('two before\n{% body %}\ntwo after') }
};
const res = renderLayouts(file, layoutCollection);
console.log(res.contents.toString());
// two before
// one before
//
Options
$3
Type:
Default:
By default, layouts are prevented from being applied multiple times to the same string. Disable this by setting
to true.Example
`js
layouts(file, layoutCollection, { disableHistory: true });
`$3
Custom delimiters to use for injecting contents into layouts.
Type:
Default:
$3
Preserve leading whitespace when injecting a string into a layout.
Type:
Default:
History
$3
Breaking changes
* renames
to layoutStack
* layouts in are now the actual layout object, instead of the layout nameAdded
* Adds support for a function as the last argument. If passed, the function is called on the file and each layout with this signature:
fn(file, layout).$3
Breaking changes
* The main
layouts() function now expects a file object as the first argument. This can be an object with path, layout and contents properties, or a valid vinyl file. See the API docs for more details.$3
Breaking changes
* change
options.tag to options.contentTagHousekeeping
* update tests to use
instead of should$3
* All view objects must now have a
property, following vinyl conventions.About
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Running Tests
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:
`sh
$ npm install && npm test
`
Building docs
_(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:
sh
$ npm install -g verbose/verb#dev verb-generate-readme && verb
``You might also be interested in these projects:
* assemble: Get the rocks out of your socks! Assemble makes you fast at creating web projects… more | homepage
* templates: System for creating and managing template collections, and rendering templates with any node.js template engine… more | homepage
* verb: Documentation generator for GitHub projects. Verb is extremely powerful, easy to use, and is used… more | homepage
| Commits | Contributor |
| --- | --- |
| 151 | jonschlinkert |
| 26 | doowb |
Brian Woodward
* GitHub Profile
* Twitter Profile
* LinkedIn Profile
Copyright © 2019, Brian Woodward.
Released under the MIT License.
*
_This file was generated by verb-generate-readme, v0.8.0, on April 11, 2019._