beard
Advanced tools
Readme
More than a mustache.
npm install beard
const data = {
noun: 'beards',
capitalize: str => str.charAt(0).toUpperCase() + str.slice(1)
};
const beard = require('beard');
const engine = beard({
templates: {
'/example': '{{capitalize(noun)}} are itchy.'
}
});
const result = engine.render('/example', data);
console.log(result); // returns 'Beards are itchy.'
opts (object) - An object literal with the following optional engine options:
'~' in paths, E.g. '~/layout').false to disable caching of template files. Defaults to true.asset tag. Looks up asset paths. See asset example below.path (string) - A string to be parsed and populated by the view object.
locals (object) - An object of data and/or methods which will populate the template string.
const beard = require('beard');
const engine = beard({
templates: {
'/layout': 'header | {{view}} | footer',
'/app/page/content': "{{extends '/layout'}}content {{include '~/component'}}",
'/app/component': 'and component'
},
root: '/',
home: 'app/',
cache: true
});
const result = engine.render('/app/page/content');
console.log(result); // returns 'header | content and component | footer'
Includes a template, can optionally pass locals.
{{include 'template'}}
{{include 'template', {arg: 'val', arg2: 'val2'}}}
{{include 'template', {
arg1: 'val1',
arg2: 'val2'
}}}
Extends template with a layout. Template will be accessible as "view" variable.
layout.brd.html
<html>
<body>
{{view}}
</body>
</html>
and rendering:
{{extends 'layout'}}view content
Returns:
<html>
<body>
view content
</body>
</html>
Assets are used to reference external files. You can control and modify the behavior of the tag via
the assets callback option.
engine = beard({
asset: path => '/assets/' + path
});
Used in a template:
<html>
<head><link rel="stylesheet" type="text/css" href="{{asset 'styles.css'}}"></head>
</html>
Returns:
<html>
<head><link rel="stylesheet" type="text/css" href="/assets/styles.css"></head>
</html>
The put tag outputs a local variable or a block, or an empty string if the value doesn't exist.
{{put foo}}
This will output the value of foo, if defined, or a blank string if not. Conversely, accessing it
directly, such as {{foo}} would raise an error if it were undefined.
Make content available for rendering in any context (such as an extended layout or an included partial.)
{{block middle}}
Middle
{{endblock}}
Top
{{middle}}
Bottom
Returns:
Top
Middle
Bottom
You can also conditionally check if a block is set.
{{block cart}}
everything you have put in your cart...
{{endblock}}
// another template
{{exists cart}}
{{cart}}
{{else}}
Your cart is empty.
{{end}}
Will returns:
everything you have put in your cart...
Using put is a simple way to output the block content if you are unsure if it has been set:
{{put header}}
This will output an empty string if the header has not been set.
{{if x === 1}}
x is 1
{{else if x > 1}}
x is greater than 1
{{else}}
x is less than 1
{{end}}
Iterate over properties in object.
{{for key, value in object}}
{{key}} = {{value}}
{{end}}
Iterate over array.
{{each item in array}}
{{item.property}}
{{end}}
Released under MIT license.
FAQs
More than a mustache.
The npm package beard receives a total of 58 weekly downloads. As such, beard popularity was classified as not popular.
We found that beard demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer 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.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.