❤
npm
Sign UpSign In

cortex-handlebars-compiler

1.5.4 • Public • Published

cortex-handlebars-compiler NPM version Build Status Dependency Status

Handlebar helpers for cortex template.

Install

$ npm install cortex-handlebars-compiler --save

Usage

var compiler = require('cortex-handlebars-compiler');

compiler(options)

Returns the compiler.Compiler instance.

Class: compiler.Compiler(options)

A single compiler instance only cares about one template file.

  • options Object
    • pkg Object object of cortex.json
    • shrinkWrap Object object of cortex-shrinkwrap.json
    • cwd path the root directories of current project.
    • path path path of the current template file
    • href_root url the url base of the hyper reference, 'efte://efte' for example.

.compile(template)

  • template String template string

Parses the template string and returns function(data) the parsed function.

template:

<body>
{{{facade 'a@1.0.0'}}}
</body>

instance.compile(template)();

Then you will get: (which is beautified)

<html>
<head></head>
<body>
 
<script src="../../../neuron/5.1.0/neuron.min.js"></script>
<script>
neuron.config({
  ranges: tree
  path: "../../../"
});
</script> 
<script>
facade({
  mod:"cortex-hybrid-sample@0.1.0"
});
</script> 
</body>
</html>

.register(helper, handler)

  • helper String the name of the helper
  • handler function(title, helper_options) see handlebars for details

Registers a new helper handler.

Returns this.

Built-in helpers

{{{facade '<package-name>'}}}

The first 'facade' will also output the engines and configurations.

{{{href '<link>'}}}

Creates a special link to navigate through business units

link

Relative links: ./page.html

External link to other units: <unit-name>/path/to.html

<!-- 
  If the current unit is 'foo', 
  and the current template is 'template/a.html'
-->
<a href="{{{href './b.html'}}}" >link</a>
<a href="{{{href 'bar/folder/index.html'}}}">external link</a>

You will get:

<a href="efte://efte/foo/template/a.html">link</a>
<a href="efte://efte/bar/folder/index.html">external link</a>

License

MIT

Readme

Keywords

Package Sidebar

Install

npm i cortex-handlebars-compiler

Repository

github.com/cortexjs/cortex-handlebars-compiler

Homepage

github.com/cortexjs/cortex-handlebars-compiler

Weekly Downloads

1

Version

1.5.4

License

MIT

Last publish

Collaborators

  • yyy
  • kael
  • spud
Try on RunKit
Report malware