Skip to content

Latest commit

 

History

History
115 lines (70 loc) · 2.44 KB

readme.md

File metadata and controls

115 lines (70 loc) · 2.44 KB
Raw

Grunt Render

This library was created with the belief that a server is smarter than just delivering static assets and thus can deal with the necessary build process for compiling and delivering a production-ready web application.

From a workflow perspective, this method alleviates from duplication in the codebase repository and relieves developers from running extraneous building processes on their local machines.

The build process is dead, long live the build.

Features

  • Supports: JS, CSS, LESS
  • Automatically generates markup
  • Optionally outputs js as a require.js config object
  • Compares existing files with modified date and md5 signature

Install

npm install grunt-render

Usage

Grunt render uses the same api as the regular grunt tasks, only it executes them on the server side as needed.

Javascript

You can call the methods directly any time:

var grunt_render = require('grunt-render')

grunt_render.js({
	name : "helpers",
	files : ["/assets/js/helpers/underscore.js", "/assets/js/helpers/handlebars.js"]
});

Alternatively:

{{#grunt "js" "helpers"}}
/assets/js/helpers/underscore.js
/assets/js/helpers/handlebars.js
{{/grunt}}

CSS

In line with JavaScripts, stylesheets can be minified programatically:

grunt_render.css({
	name : "styles",
	files : ["/assets/css/stylesheet1.css", "/assets/css/stylesheet2.css"]
});

or in a view using a (Handlebars) helper

{{#grunt "css" "styles"}}
/assets/css/stylesheet1.css
/assets/css/stylesheet2.css
{{/grunt}}

LESS

With LESS stylesheets, the JavaScript lib is automaically added when the assets are unminified.

Using the aforementioned Handlebars helper, the LESS styles are initiated like this:

{{#grunt "less" "main"}}
/assets/css/main.less
{{/grunt}}

Options

  • main : the location of the initializing script

  • cdn : domain of the cdn

  • less : options related to the less minification

  • require : options related to require.js

  • minify : options related with the miinfication process

Methods

  • js() : add one or more javascript files

  • css() : add one or more stylesheet files

  • less() : add one or more less files

  • main() : render the final output

Credits

Initiated by Makis Tracend ( @tracend )

Distributed through Makesites.org

Released under the MIT license