xcambar / ember-cli-showdown

Ember component to render markdown into HTML.

Ember CLI Showdown

This addon provides a component that transforms Markdown into valid HTML.

Usage

From within your Ember CLI application, run the following:

• ember install ember-cli-showdown

Passing a markdown string inline:

{{markdown-to-html "#Markdown is cool [link](http://emberjs.com)"}}

<!-- Output -->
<h1>Markdown is cool <a href="http://emberjs.com">link</a></h1>

You can also pass a bound value:

{{markdown-to-html postContent}}

Showdown Options

You can use configuration settings from Showdown:

{{markdown-to-html
  markdown=postContent
  strikethrough=true
  literalMidWordUnderscores=true
  simplifiedAutoLink=true}}

Showdown Extensions

You can load Showdown Extensions by specifying the "extensions" property when initializing your component:

{{markdown-to-html
  markdown=postContent
  extensions=myExtensionList}}

{{markdown-to-html
  markdown=postContent
  extensions='foo bar baz'}}

(myExtensionList can be an array of strings or a space separated string)

Note that you'll have to register your extensions with Showdown first. For example, in an initializer:

// app/initializers/register-showdown-extensions.js

export function initialize() {
  showdown.extension("myExtensionName", function() {
    return [{
      type: 'html',
      regex: '<blockquote>',
      replace: '<blockquote class="blockquote">'
    }];
  });
}

export default {
  name: 'register-showdown-extensions',
  initialize
};

Dependencies

• Showdown

Development

• git clone https://github.com/gcollazo/ember-cli-showdown.git
• cd ember-cli-showdown
• npm install
• bower install

Previewing

• ember server
• Visit your app at http://localhost:4200.

Running Tests

• ember test
• ember test --server

Building

• ember build