# cortex-handlebars-compiler [](http://badge.fury.io/js/cortex-handlebars-compiler) [](https://travis-ci.org/cortexjs/cortex-handlebars-compiler) [](https://gemnasium.com/cortexjs/cortex-handlebars-compiler)
Handlebar helpers for cortex template.
## Install
```bash
$ npm install cortex-handlebars-compiler --save
```
## Usage
```js
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:
```
{{{facade 'a@1.0.0'}}}
```
```js
instance.compile(template)();
```
Then you will get: (which is beautified)
```html
```
### .register(helper, handler)
- helper `String` the name of the helper
- handler `function(title, helper_options)` see [handlebars](http://npmjs.org/package/handlebars) for details
Registers a new helper handler.
Returns `this`.
## Built-in helpers
### `{{{facade ''}}}`
The first 'facade' will also output the engines and configurations.
### `{{{href ''}}}`
Creates a special link to navigate through business units
#### link
Relative links: `./page.html`
External link to other units: `/path/to.html`
```html
linkexternal link
```
You will get:
```html
linkexternal link
```
## License
MIT