❤
npm
Sign UpSign In

templateking

1.1.11 • Public • Published

templateking

Nested templates that use CSS selectors to populate dynamic data points.

(Intended for server-side use. For a similar client-side library see shave-template or curly-free-template.)

This module allows you to develop plain HTML/CSS templates with dummy data in the places dynamic data will be inserted. The benefit is that the templates can be developed independently from the program that dynamically inserts data into the web page.

It also provides for layering templates so you can have one template for the entire site that is used on every page, one template for each section that is used throughout it's own section, one template for each sub-section used on each page in it's particular sub-seciton, and one template for each page.

So, for an example, the page template can be wrapped in a sub-section template, those together can be wrapped in a section template, and those can be wrapped in a site template.

The number of nested layers is unlimited.

Once it compiles the templates you've listed, this module applies an object you've provided that identifies CSS selectors as key names paired with dynamic data values and replaces the default content of the elements in the templates that are identified by the corresponding CSS selectors.

simple example

// require the module and identify the directory that contains the template files
var templates = require('templateking')({directory: 'public'}) 
 
templates(
 
    // list the nested templates, starting with outer to inner
    ['simple.html', 'message.html'], 
 
    // provide an object of CSS selector keys with values to replace the default template text
    {
        'title':     'My New Title', 
        '#message':  'Hello templateking!', 
        '#datetime': Date()
    }, 
 
    // provide a writeable stream to pipe the resulting HTML text to
    process.stdout 
)

Given the templates:

simple.html

<!DOCTYPE html>
<html>
  <head>
    <title>templateking</title>
  </head>
  <body>
    <div class="template">template</div>
  </body>
</html>

And message.html

    <h3 id="message">Message</h3>
    <div>Date/Time: <span id="datetime">datetime</span></div>

Will output:

<!DOCTYPE html>
<html>
    <head>
        <title>My New Title</title>
    </head>
    <body>
        <div class="template">
            <h3 id="message">Hello templateking!</h3>
            <div>Date/Time: <span id="datetime">Tue Nov 24 2015 12:51:23 GMT-0600 (CST)</span></div>
        </div>
    </body>
</html>

(Layout reformated for clarity.)

See the examples directory for more examples and additional functionality, including grabbing a portion of a template and repeatedtly writing it out to form table rows and lists.

license

MIT

Dependencies (9)

Dev Dependencies (1)

Package Sidebar

Install

npm i templateking

Repository

github.com/bloodyKnuckles/templateking

Homepage

github.com/bloodyKnuckles/templateking#readme

Weekly Downloads

2

Version

1.1.11

License

MIT

Unpacked Size

15.7 kB

Total Files

15

Last publish

Collaborators

  • bloodyknuckles
Try on RunKit
Report malware