A layout and partials pre-compile tool for mustache based template engine using in express.
This package is for express.js 3.0+ (4.0+ also supported) users who want to use layout and partial in mustache based (mustache, hogan, handlebars) template engines, with only a really simple configuration.
A few features:
$ npm install --save mustlayout
In your express application main file app.js:
var express = require('express');
var app = express();
require('mustlayout').engine(app, {
engine: require('hogan'),
ext: '.tpl',
views: '/views',
partials: '/views/partials', // optional, default to '/views'
layouts: '/views/layouts', // optional, default to '/views'
cache: '/views/cache', // optional, default to '/views/cache'
verbose: true // optional, default is false
});
app.get('/', function (req, res, next) {
res.render('index');
});
app.listen(6060);
By using MustLayout, you never need to write the native view engine configuration of express.
For more infomation just look into the example folder.
MustLayout use handlebars' syntax {{!<layoutName}} for layout definition in a template file. Ordinarily, you should place this line at the beginning of your template file.
Then use {{+blockName}}...{{/blockName}} to define a extensible layout block like in Smarty.
An example for template index.tpl which extended layout page.tpl:
{{!<page}}
{{+header}}
<h1>My Title</h1>
{{/header}}
{{+body}}
...
{{/body}}
And in layout page.tpl:
<!DOCTYPE html>
<html>
<head>
<title>MustLayout</title>
</head>
<body>
<div id="header">
{{+header}}Just Header{{/header}}
</div>
<div id="main">
{{+body}}Nothing{{/body}}
</div>
{{> footer }}
</body>
</html>
After you invoke res.render('index') in a controller, you will get this in browser:
<!DOCTYPE html>
<html>
<head>
<title>MustLayout</title>
</head>
<body>
<div id="header">
<h1>My Title</h1>
</div>
<div id="main">
...
</div>
<!-- something in footer.tpl -->
</body>
</html>
MustLayout build all your templates to a target cache folder (cache for default) in /views. So you must make sure that /views should be writable for everyone:
$ chmod 777 views/
And by building, layout and partial syntax will be pre-compiled into common mustache based templates in that folder before server starting. You should never worried about the performance of rendering layouts, because it only depends on what mustache engine you are using.
-EOF-
FAQs
A layout and partials pre-compile tool for mustache based template engine using in express.
We found that mustlayout 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.
Security News
Research
Socket researchers uncover how threat actors weaponize Out-of-Band Application Security Testing (OAST) techniques across the npm, PyPI, and RubyGems ecosystems to exfiltrate sensitive data.
Security News
Research
A malicious npm campaign is targeting Ethereum developers by impersonating Hardhat plugins and the Nomic Foundation, stealing sensitive data like private keys.
Research
Security News
Socket researchers uncover a malicious npm package posing as a tool for detecting vulnerabilities in Etherium smart contracts.