No Description

Alex Gleason 820518d211 1.3.0 3 years ago
lib 8bbde1b9fa Add .njk file extension 3 years ago
test 1e76cf6715 Merge remote-tracking branch 'mariosant/nunjucks-support' 3 years ago
.gitignore 589480de22 Ignores npm debug log 6 years ago
.npmignore 6978c252e6 adds .npmignore file 7 years ago
.travis.yml 84012238ad Updates CI targets 4 years ago
README.md 489fd97eaf Fork terraform into candlewax 3 years ago
appveyor.yml 84012238ad Updates CI targets 4 years ago
package.json 820518d211 1.3.0 3 years ago

README.md

Candlewax

Candlewax is a fork of Terraform for use with Wick web server. It includes support for Nunjucks and may be completely altered in the future.

Ideally, this is what we want:

  • A powerful templating language (Nunjucks) that is familiar and supports layouts.
  • No more errors from node-sass. This may require switching libraries or commitment to using LESS.

Until we can achieve these things with Harp, we feel it's worth keeping a fork. But who knows? Maybe this well become something greater. For now, use this at your own risk.

Terraform is the pre-processor engine for the Harp web server. Terraform does not write or serve files. It processes and provides a layout/partial paradigm.

Features

  • pre-processorse
  • layouts
  • partials
  • metadata (via _data.json)
  • LRU cache (production mode)

Supported Pre-Processors

HTML – EJS, Jade, Markdown, Nunjucks CSS – LESS, Stylus, Sass (SCSS) JavaScript – CoffeeScript

Install

npm install candlewax

API

Step 1) require the library

var terraform = require('candlewax')

Step 2) set the root

  • publicPath (String): path to public directory
  • globals (Object): global variables to be available to every template
var planet = terraform.root("path/to/public/dir", { "title": "Bitchin" })

Step 3) render a file

planet.render('index.jade', { "title": "Override the global title" }, function(error, body){
  console.log(body)
})

Tests

Please run the tests

npm install
npm test

License

Copyright © 2012–2014 Chloi Inc. All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.