Skip to content

Latest commit

 

History

History
137 lines (89 loc) · 4.98 KB

README.md

File metadata and controls

137 lines (89 loc) · 4.98 KB
Raw

helper-dateformat NPM version NPM downloads Linux Build Status

Template helper for adding formatted dates using node-dateformat. Works with Handlebars, Lo-Dash, underscore, or any template engine that supports helper functions. Also compatible with verb, assemble and Template.

Install

Install with npm:

$ npm install --save helper-dateformat

See node-dateformat for all available options.

Usage

This helper should work with any template engine, or as a javascript utility.

var dateformat = require('helper-dateformat');
console.log(dateformat('today'));
//=> December 24, 2016

handlebars usage

var handlebars = require('handlebars');
handlebars.registerHelper('dateformat', require('helper-dateformat'));

Usage

{{dateformat "MMMM DD, YYYY"}}

lodash and underscore usage

var helper = require('helper-dateformat');

// as a mixin
_.mixin({dateformat: helper});
_.template('<%= dateformat("MMMM DD, YYYY") %>', {});

// passed on the context
_.template('<%= dateformat("MMMM DD, YYYY") %>', {dateformat: helper});

// as an import
var settings = {imports: {dateformat: helper}};
_.template('<%= dateformat("MMMM DD, YYYY") %>', {}, settings);

templates usage

Register the helper for use with any template engine

template.helper('dateformat', require('helper-dateformat'));

assemble usage

To register the helper for use with assemble v0.6.x:

assemble.helper('dateformat', require('helper-dateformat'));

verb usage

In verbfile.js:

module.exports = function(verb) {
  verb.helper('dateformat', require('helper-dateformat'));

  verb.task('default', function() {
    return verb.src('*.md')
      .pipe(verb.renderFile())
      .pipe(verb.dest('.'));
  });
};

Templates:

{%= dateformat("MMMM DD, YYYY") %}

About

Related projects

  • handlebars-helpers: More than 130 Handlebars helpers in ~20 categories. Helpers can be used with Assemble, Generate… more | homepage
  • helper-date: Format dates with date.js and moment.js. Uses date.js to parse human readable date phrases, and… more | homepage
  • template-helpers: Generic JavaScript helpers that can be used with any template engine. Handlebars, Lo-Dash, Underscore, or… more | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Building docs

(This document was generated by verb-generate-readme (a verb generator), please don't edit the readme directly. Any changes to the readme must be made in .verb.md.)

To generate the readme and API documentation with verb:

$ npm install -g verb verb-generate-readme && verb

Running tests

Install dev dependencies:

$ npm install -d && npm test

Author

Jon Schlinkert

License

Copyright © 2016, Jon Schlinkert. Released under the MIT license.

This file was generated by verb-generate-readme, v0.2.0, on December 25, 2016.