1.0.1 • Published 7 years ago

nyun v1.0.1

Weekly downloads
2
License
MIT
Repository
github
Last release
7 years ago

Nyun

A small, fast and minimalist rendering engine for express

Install

You can get Nyun via npm.

$ npm install nyun --save

Usage

A nyun template is basically a string template embedded with variables. anything inside ${} is evaluated. Notice the backticks :D

Below is a quick example how to use nyun with express:

app.js

app.set('view engine', 'nyun')

Create a nyun template file named index.nyun in the views directory, with the following content

module.exports = (options) => {
  with(options){
      return `<html>
                <head>
                    <title>${title}<title>
                </head>
                <body>
                    <h1>${message}</h1>
                </body>
            </html>`
  }
}

Then create a route to render the index.nyun file. If the view engine property is not set, you must specify the extension of the view file. Otherwise, you can omit it.

var view = {
  title: "Joe",
  message: 'Hello there!'
};

app.get('/', function (req, res) {
  res.render('index', view);
})

Partials

Nyun supports including partials out of the box. Just require the partial with its context and its done!

index.nyun

module.exports = (options) => {
  with(options){
      return `<html>
                <head>
                    <title>${title}<title>
                </head>
                <body>
                    <h1>${require('./message.nyun')(message)}</h1>
                </body>
            </html>`
  }
}

message.nyun

module.exports = (options) => {
  with(options){
      return `<span> ${text}
                </span>`
  }
}

and the route is written as

var view = {
  title: "Joe",
  message: {text:'Hello there!'}
};

app.get('/', function (req, res) {
  res.render('index', view);
})