Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/empress/ember-cli-showdown
Ember component to render markdown into HTML.
https://github.com/empress/ember-cli-showdown
Last synced: 5 days ago
JSON representation
Ember component to render markdown into HTML.
- Host: GitHub
- URL: https://github.com/empress/ember-cli-showdown
- Owner: empress
- License: mit
- Created: 2014-08-16T20:36:54.000Z (over 10 years ago)
- Default Branch: main
- Last Pushed: 2024-03-29T16:16:51.000Z (9 months ago)
- Last Synced: 2024-12-14T06:06:53.634Z (12 days ago)
- Language: JavaScript
- Homepage: https://empress.github.io/ember-cli-showdown/
- Size: 2.87 MB
- Stars: 101
- Watchers: 6
- Forks: 35
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# ember-cli-showdown
[](http://emberobserver.com/addons/ember-cli-showdown)
This addon provides a component that transforms [Markdown](http://en.wikipedia.org/wiki/Markdown) into valid HTML.
* Fastboot compatible
## Compatibility
* Ember.js v3.16 or above
* Ember CLI v3.16 or above
* Node.js v18 or above
## Installation
- `ember install ember-cli-showdown`
## Usage
Passing a markdown string inline:
```handlebars
```
```html
Markdown is cool link
```
You can also pass a bound value:
```handlebars
```
### Showdown Options
You can use [configuration settings from Showdown][showdown-config]:
```handlebars
```
[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;
}
```
### Showdown Extensions
You can load [Showdown Extensions](https://github.com/showdownjs/showdown/wiki/extensions) by specifying the
"extensions" property when initializing your component:
```handlebars
```
```handlebars
```
(`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 via `import showdown from 'showdown'`
* Remove any use of `FastBoot.require('require')` with `import 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
* [Showdown](https://github.com/showdownjs/showdown)
## Contributing
See the [Contributing](CONTRIBUTING.md) guide for details.
## License
This project is licensed under the [MIT License](LICENSE.md).