JSPM

  • Created
  • Published
  • Downloads 51766
  • Score
    100M100P100Q174914F
  • License MIT

Load templates.

Package Exports

  • load-templates

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (load-templates) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

load-templates NPM version Build Status

Load templates.

Install

Install with npm

$ npm i load-templates --save

Usage

var Loader = require('load-templates');
var loader = new Loader();

Pass a string or array of globs or file paths, or an object to the load method:

loader.load('a.md', {a: 'b'});
loader.load('*.md', {a: 'b'});
loader.load(['*.md'], {a: 'b'});
loader.load({path: 'a.md', a: 'b'});
loader.load({'a.md': {path: 'a.md', a: 'b'}});

And get shiny, normalized template objects back:

{ 'a.md': {path: 'a.md', content: 'this is content.', a: 'b'},
  'b.md': {path: 'b.md', content: 'this is content.', a: 'b'},
  'c.md': {path: 'c.md', content: 'this is content.', a: 'b'}}

Options

options.relative

Type: Boolean

Default: undefined

When false paths will not be made relative to the current working directory.

Valid formats

See the docs and tests for valid formats. WIP.

Coverage

-------------------|-----------|-----------|-----------|-----------|
File               |   % Stmts |% Branches |   % Funcs |   % Lines |
-------------------|-----------|-----------|-----------|-----------|
   load-templates/ |     98.65 |     95.06 |       100 |     98.61 |
      index.js     |     98.65 |     95.06 |       100 |     98.61 |
-------------------|-----------|-----------|-----------|-----------|
All files          |     98.65 |     95.06 |       100 |     98.61 |
-------------------|-----------|-----------|-----------|-----------|
  • assemble: Static site generator for Grunt.js, Yeoman and Node.js. Used by Zurb Foundation, Zurb Ink, H5BP/Effeckt,… more
  • template: Render templates using any engine. Supports, layouts, pages, partials and custom template types. Use template… more
  • verb: Documentation generator for GitHub projects. Extremely powerful, easy to use, can generate anything from API… more

Running tests

Install dev dependencies:

$ npm i -d && npm test

Contributing

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

Author

Jon Schlinkert

License

Copyright © 2014-2015 Jon Schlinkert Released under the MIT license.


This file was generated by verb-cli on July 26, 2015.