## API ```js var markdown = require('helper'); ``` Returns a function that returns the helper, allowing an options object to be passed: ```js var hbs = require('handlebars'); hbs.registerHelper('markdown', markdown([options])); ``` **Example** Pass a custom `highlight` function for syntax highlighting to [Remarkable][], the markdown renderer: ```js var hljs = require('highlight.js'); var markdown = require('helper-markdown'); function highlight(code, lang) { try { try { return hljs.highlight(lang, code).value; } catch (err) { if (!/Unknown language/i.test(err.message)) { throw err; } return hljs.highlightAuto(code).value; } } catch (err) { return code; } } hbs.registerHelper('markdown', markdown({ highlight: highlight })); ``` ## Usage examples With Handlebars: ```handlebars
{{#markdown}} # Heading > this is markdown foo bar baz {{/markdown}}
``` Results in: ```html

Heading

this is markdown

foo bar baz

``` ## Register the helper > This should work with any engine, here are a few examples ### templates The `templates` library supports any templates engine supported by consolidate. To register the helper with [templates][]: ```js var templates = require('templates'); var app = templates(); app.helper('markdown', require('helper-markdown')); ``` ### assemble To register the helper for use with [assemble][] v0.6.0 and higher: ```js assemble.helper('markdown', require('helper-markdown')); ``` ### verb Register the helper for use with [verb][]: ```js var verb = require('verb'); verb.helper('markdown', require('helper-markdown')); ``` ### handlebars To register the helper with [handlebars][]: ```js var handlebars = require('handlebars'); handlebars.registerHelper('markdown', require('helper-markdown')); ``` ### lodash To register the helper with [Lo-Dash][] or [underscore][]: ```js var markdown = require('helper-markdown'); // as a mixin _.mixin({markdown: markdown}); _.template('<%= _.markdown("# heading") %>', {}); //=> '

heading

\n' // passed on the context _.template('<%= markdown("# heading") %>', {markdown: markdown}); //=> '

heading

\n' // as an import var settings = {imports: {markdown: markdown}}; _.template('<%= markdown("# heading") %>', {}, settings); //=> '

heading

\n' ```