Ember component to render markdown into HTML.
npm install ember-cli-showdown
This addon provides a component that transforms Markdown into valid HTML.
* Fastboot compatible
* Ember.js v3.16 or above
* Ember CLI v3.16 or above
* Node.js v18 or above
- ember install ember-cli-showdown
Passing a markdown string inline:
``handlebars`
`html`Markdown is cool link
You can also pass a bound value:
`handlebars`
You can use [configuration settings from Showdown][showdown-config]:
`handlebars`
@strikethrough={{true}}
@literalMidWordUnderscores={{true}}
@simplifiedAutoLink={{true}}
/>
[showdown-config]: https://github.com/showdownjs/showdown#valid-options
#### Global Showdown Options
Global options are supported as of 2.11.x. This lets you define options that will be used
for showdown options that were not provided as an attribute.
An example where you always want to auto link:
`js
// config/environment.js
module.exports = function(environment) {
var ENV = {
showdown: {
simplifiedAutoLink: true
}
}
return ENV;
}
`
You can load Showdown Extensions by specifying the
"extensions" property when initializing your component:
`handlebars`
@extensions={{myExtensionList}}
/>
`handlebars`
@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:
`js
// app/initializers/register-showdown-extensions.js
import showdown from 'showdown';
export function initialize() {
showdown.extension("myExtensionName", function() {
return [{
type: 'html',
regex: '
',
replace: ''
}];
});
}export default {
name: 'register-showdown-extensions',
initialize
};
`[showdown-extensions]: https://github.com/showdownjs/showdown/wiki/extensions
3.x to 4.3 migration
* Global showdown
is no longer supported. Must be imported viaimport showdown from 'showdown'FastBoot.require('require')
* Remove any use ofwithimport showdown from 'showdown'7.x to 8.x migration
* Positional parameters are no longer supported. Use the @markdown
argument to provide the markdown content to`. Dependencies
* ShowdownContributing
See the Contributing guide for details.
License
This project is licensed under the MIT License.