1.0.2 • Published 11 months ago

pug-tree v1.0.2

Weekly downloads
5
License
MIT
Repository
github
Last release
11 months ago

pug-tree
Credit: flickr/dapuglet

pug-tree

NPM version Build Status Dependency Status

pug-tree is a tiny library design to build nested objects of templating functions from a given directory of pug template files.

Installation and Usage

  • npm install --save pug-tree
  • require('pug-tree')(directory, defaults)
    • directory should be the top level of your templates folder, usually something like path.join(__dirname, 'templates')
    • defaults is properties object that is pre-bound to template - this is a good place to include information that doesn't usually change like title
    • See test/test.js for usage example

Given a folder structure:

<project-name>
↳ templates
  ↳ index.pug
  ↳ nested
    ↳ page.pug

You will be able to do the following:

var templates = require('pug-tree')(path.join(__dirname, 'templates'), { title: title })
var indexHtml = templates.index({ body: indexBody })
var nestedPageHtml = templates.nested.page({ body: nestedPageBody })

Where title and body are both available to each of the templates.