Code Monkey home page Code Monkey logo

shoko's Introduction

Shoko

A node.js templating engine

Shoko is a simple to use templating engine, with a very straight forward and intuative syntax. Shoko also offers many other features, including: mixins, variables, comments.
As shoko is in it's early development, many features that we intend to add are stil missing.

Installation

Shoko is super easy to get up and running. simply download it from npm, like this.

npm install shoko --save

Syntax

Shoko has a very easy to grasp syntax. Elements in shoko are seprated by curly braces.
Here is an example:

doctype html
html {
    head {
        title {
            'My First Shoko Page'
        }
    }

    body {
        h1 {
            'Shoko is awesome.'
        }
    }
}

Which will render to this HTML:

<!DOCTYPE html>
<head>
    <head>
        <title>My First Shoko Page</title>
    </head>

    <body>
        <h1>
            My First Shoko Page
        </h1>
    </body>
</head>

API

Shoko is really easy to use.
To render plain shoko text, just use the render function.

const shoko = require('shoko');  

let textToRender = 'h1 { "Hello world" }';

//<h1>Hello world</h1>
let renderedHTML = shoko.render(textToRender);

To render from a file, use the renderFile function.

let renderedFile = shoko.renderFile('file.sk');

Yes, I'ts that simple!

Framework Integration

List of frameworks:

  • Express.js
  • hapi.js

Integrating with Express.js

Integrating Shoko with Express is so easy.
Just set the engine to the Shoko renderFile function.

app.engine('sk', shoko.renderFile);

Then, you can just render views normally. For example:

app.get('/', (res, req) => {
    res.render('index', {});
});

Integrating with Hapi.js

Like express, integrating Shoko with Hapi is very easy; Just register shoko as the engine.

server.register(require('vision'), (err) => {
    server.views({
        engines: {
            html: require('shoko')
        }
    });
});

Then, you can just render views normally. For example:

server.route({
    method: 'GET',
    path: '/',
    handler: function (request, reply) {
        reply.view('index');
    }
});

shoko's People

Contributors

nirkog avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

eladnaeh

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.