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
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:
$ npm install --save layouts
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 optionsThis 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.
const renderLayouts = require('layouts');
const file = {
contents: Buffer.from('<div>Wrap me with a layout!!!</div>'),
layout: 'one'
};
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
// <div>Wrap me with a layout!!!</div>
// one after
// two after
Type: boolean
Default: undefined
By default, layouts are prevented from being applied multiple times to the same string. Disable this by setting disableHistory to true.
Example
layouts(file, layoutCollection, { disableHistory: true });
Custom delimiters to use for injecting contents into layouts.
Type: regex
Default: /{% (body) %}/g
Preserve leading whitespace when injecting a string into a layout.
Type: boolean
Default: undefined
Breaking changes
layoutHistory to layoutStacklayoutStack are now the actual layout object, instead of the layout nameAdded
fn(file, layout).Breaking changes
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.Breaking changes
options.tag to options.contentTagHousekeeping
assert instead of shouldpath property, following vinyl conventions.Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
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
(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
You might also be interested in these projects:
| Commits | Contributor |
|---|---|
| 151 | jonschlinkert |
| 26 | doowb |
Brian Woodward
Copyright © 2019, Brian Woodward. Released under the MIT License.
This file was generated by verb-generate-readme, v0.8.0, on April 11, 2019.
FAQs
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
The npm package layouts receives a total of 28,626 weekly downloads. As such, layouts popularity was classified as popular.
We found that layouts demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.