- Notifications
You must be signed in to change notification settings - Fork6
baryshev/just
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation
JavaScript template engine.
npm install just
- Caching templates
- Automatic reloading of changed templates
- JavaScript code in templates
- Supports tag customization
- Node.JS and client-side support
- Powerful but simple syntax
- Inheritance, partials, blocks
varJUST=require('just');varjust=newJUST({root :__dirname+'/view',useCache :true,ext :'.html'});just.render('page',{title:'Hello, World!'},function(error,html){console.log(error);console.log(html);});
You may use JavaScript object as root.
varJUST=require('just');varjust=newJUST({root :{layout:'<html><head><title><%= title %></title></head><body><%*%></body></html>',page:'<%! layout %><p>Page content</p>'},useCache :true});just.render('page',{title:'Hello, World!'},function(error,html){console.log(error);console.log(html);});
See full example inexamples folder.
<%= someVar %>
<% for (var i = 0; i < articles.length; i++) { %><% this.partial('article', { article: articles[i] }); %><% } %>
or
<% if (user.authenticated) { %><%@ partials/user %><% } else { %><%@ partials/auth %><% } %>
<%! layout %>
or
<%! layout { customVar: 'Hello, World!' } %>
Use
<%*%>
in parent template to define the insertion point.
<%@ partial %>
or
<%@ partial { customVar: 'Hello, World!' } %>
<%[ blockName %><p>This is block content</p><%]%>
Use
<%* blockName %>
in parent template to define the insertion point.
Blocks supports more than one level of inheritance and may be redefined.
<%? someVar == 1 %><p>Var is 1</p><%: someVar == 2 %><p>Var is 2</p><%:%><p>Var is other</p><%?%>
<%| comments comment %><p><%= comment.text %></p><%|%>
root
Templates root folder or JavaScript object containing templatesext
Extension of templates, defaulting to '' (not used for JavaScript objects as root)useCache
Compiled functions are cached, defaulting to falsewatchForChanges
Automatic reloading of changed templates, defaulting to false (useful for debugging with enabled useCache, not supported for client-side)open
Open tag, defaulting to '<%'close
Closing tag, defaulting to '%>'
Basically, includejust.min.js to a page and JUST ready to use.
varjust=newJUST({root :'/view',useCache :true,ext :'.html'});just.render('page',{title:'Hello, World!'},function(error,html){console.log(error);console.log(html);});
NOTE: root folder must be on the same domain to avoid cross-domain restrictions.
(The MIT License)
Copyright (c) 2012 Vadim M. Baryshev <vadimbaryshev@gmail.com>
Permission is hereby granted, free of charge, to any person obtaininga copy of this software and associated documentation files (the'Software'), to deal in the Software without restriction, includingwithout limitation the rights to use, copy, modify, merge, publish,distribute, sublicense, and/or sell copies of the Software, and topermit persons to whom the Software is furnished to do so, subject tothe following conditions:
The above copyright notice and this permission notice shall beincluded in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OFMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANYCLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THESOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.