xtpl

nodejs wrapper around xtemplate engine (easier for expressjs and koajs)


docs

$3

refer: https://github.com/xtemplate/xtemplate

$3

#### methods

##### config or get xtpl global option:
``javascript
Object config(option:Object)
`

option details:



























name	type	default	description
encoding	String	utf-8	xtpl file encoding
XTemplate	Object	require('xtemplate')	xtemplate module value

if options is undefined, then this method will return global config.

##### render file
`javascript
void renderFile(path:String, options:Object, callback:function)
`
parameter details:

































name	type	default	description
path	String		xtpl template file
option	Object		data to be rendered. the following properties will be used for control. name type default description cache Boolean false whether cache xtpl by path setting['view encoding'] String global encoding encoding for read xtpl files
callback	function		callback

`
npm install xtpl xtemplate --save
`

`javascript
var xtpl = require('xtpl');
xtpl.renderFile('./x.xtpl',{
x:1
},function(error,content){

});
`

##### express adaptor

`javascript
xtpl.__express = xtpl.renderFile
`

##### clear cache

clear xtemplate cache cached by xtpl file path

`javascript
void clearCache(path:String);
`

$3

`javascript
var app = require('express')();
app.set('views','./views');
app.set('view engine', 'xtpl');
app.use(function(req, res){
res.render('test',{data:1});
});
`

$3

`javascript
var app = require('xtpl/lib/koa')(require('koa')(),{
views:'./views'
});
app.use(function*(){
yield this.render('test',{data:1});
});
`

$3

`javascript
const koa = require('koa'),
app = new koa()
const xtpl = require('xtpl/lib/koa2')
xtpl(app, {
views:'./views'
});
app.use(async (ctx, next) => {
ctx.body = await ctx.render('test',{data:1});
});
``

Example

├── footer.xtpl
├── header.xtpl
├── index.xtpl
├── layout.xtpl
├── layout1.xtpl
└── sub
└── header.xtpl

index.xtpl

{{extend ("./layout1")}}

{{#block ("head")}}


{{/block}}

{{#block ("body")}}

{{title}}

{{/block}}

layout1.xtpl

{{{block ("head")}}}


{{{include ("./header")}}}
{{{block ("body")}}}
{{{include ("./footer")}}}

render

res.render("index", {title: "xtpl engine!"})

output

header

sub header

xtpl engine!

footer

changelog

https://github.com/xtemplate/xtpl/milestones

License

xtpl is released under the MIT license.