Skip to content

Latest commit

 

History

History
120 lines (89 loc) · 3.26 KB

README.md

File metadata and controls

120 lines (89 loc) · 3.26 KB
Raw

grunt-ejs-locals

A Grunt task for compiling ejs templates with the taste of layouts, blocks and partials.
This Grunt plugin uses randometc's ejs-locals.

NPM version Dependency Status devDependency Status NPM

Getting Started

This plugin requires Grunt ~0.4.0

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-ejs-locals --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-ejs-locals');

This plugin was designed to work with Grunt 0.4.x. If you're still using grunt v0.3.x it's strongly recommended that you upgrade.

EJS-locals task

Run this task with the grunt ejs command.

Settings

Task targets, files and options may be specified according to the grunt Configuring tasks guide.

Usage Examples

Add the task to your config and specify the destination for the compiled file:

grunt.initConfig({
  ejs: {
    all: {
      src: ['**/*.ejs', '!_partials/**/*', '!_layouts/**/*'],
      cwd: 'src/',
      dest: 'dist/',
      expand: true,
      ext: '.html',
      options: {
        title: 'EJS-locals',
        headline: 'EmbeddedJS with locals',
        paragraph: 'A Grunt task for compiling ejs templates with the taste of layouts, blocks and partials.'
      }
    }
  }
});

_layouts/default.ejs:

<html>
  <head>
    <title><%= title %></title>
  </head>
  <body>
    <header>
      <%- partial('_partials/header') %>
    </header>
    <main id="content">
      <%- body %>
    </main>
  </body>
</html>

index.ejs:

<% layout('_layouts/default') -%>

<h1><%= headline %></h1>
<p><%= paragraph %></p>

Compiles to:

<html>
  <head>
    <title>EJS-locals</title>
  </head>
  <body>
    <header>
      <p>This is a header partial</p> 
    </header>
    <main id="content">
      <h1>EmbeddedJS with locals</h1>
      <p>A Grunt task for compiling ejs templates with the taste of layouts, blocks and partials.</p>
    </main>
  </body>
</html>

Release History

  • 0.1.1 update tasks documentation
  • 0.1.0 initial release

License

Licensed under the MIT license.

Copyright (c) 2014 Andreas Klein