template-config

template-config

Adds declarative configuration functionality to Template.

Install

Install with npm

$ npm i template-config --save

Note that some of

Usage

In the following example, app represents the latest version of any template.js-based application, like assemble, verb, scaffold, boilerplate, etc. See the implementation table for details.

var config = require('template-config');
var app = require('template');

// add a `config` method to `app`
app.mixin('config', config);

// the following config will automatically create the
// specified template collections, and load files from
// the provided directories based on the glob patterns
app.config({
  base: 'fixtures/templates',
  renameKey: function (key) {
    return path.basename(key, path.extname(key));
  },
  templates: {
    pages: {
      base: 'pages',
      patterns: '*.hbs',
      options: {},
    },
    posts: {
      base: 'posts',
      patterns: '*.md',
      options: {},
    },
    layouts: {
      base: 'layouts',
      patterns: '*.hbs',
      options: { viewType: 'layout' },
    },
    includes: {
      base: 'includes',
      patterns: '*.hbs',
      options: { viewType: 'partial' },
    }
  }
});

Implementation table

When the application is checked, it's stable and ready to use with this library:

• snippet
• template
• scaffold
• boilerplate
• assemble
• generate
• verb

Related projects

• assemble: Static site generator for Grunt.js, Yeoman and Node.js. Used by Zurb Foundation, Zurb Ink, H5BP/Effeckt,… more
• boilerplate: Easily create, share and use boilerplates for node.js and web projects.
• generate: Project generator, for node.js.
• snippet: CLI and API for easily creating, reusing, sharing and generating snippets of code from the… more
• scaffold: Generate a project or files from scaffolds.
• 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

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2015 Jon Schlinkert Released under the MIT license.

This file was generated by verb-cli on August 19, 2015.