Markdown Helpers

Availability: Registered in both the Node and browser builds. The browser build renders inline markdown only — the Node build also accepts a file path and will read its contents before rendering.

Table of Contents

• {{markdown}}
• {{md}}

{{markdown}}

Block helper that converts a string of inline markdown to HTML.

Params

• string {String}: Markdown string to convert
• returns {String}: HTML string

Example

{{#markdown}}
# Foo
{{/markdown}}
<!-- results in: <h1>Foo</h1> -->

{{md}}

Converts a markdown string to HTML, or reads a markdown file from the file system and converts its contents to HTML.

Params

• filepath {String}: Markdown string or path to a markdown file
• returns {String}: HTML string

Example

{{md "# Hello World"}}
<!-- results in: <h1>Hello World</h1> -->

{{md "foo/bar.md"}}
<!-- reads file and converts to HTML -->