# ember-cli-showdown

> Ember component to render markdown into HTML.

Latest version **10.0.0** (published 2026-06-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install ember-cli-showdown
pnpm add ember-cli-showdown
yarn add ember-cli-showdown
bun add ember-cli-showdown
```

## Health

**Score 65/100 (B)** — status: active.

Positive: esm support; no vulnerabilities; has provenance; recently updated; high maintenance score.

Warnings: low downloads; no types.

## Facts

| | |
|---|---|
| Version | 10.0.0 |
| Published | 2026-06-23 |
| First published | 2014-08-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >= 18 |
| Dependencies | 3 |
| Unpacked size | 15.8 KB |
| Known vulnerabilities | 0 (+3 in 1 direct dependencies) |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 100 |
| Maintainers | real_ate, elwayman02, jenweber, melsumner, nickschot, jaredgalanis, minthamie, jasonmit, jpadilla, gcollazo |
| Keywords | ember-addon, showdown, markdown, component, emberjs |

## Links

- npm: https://www.npmjs.com/package/ember-cli-showdown
- Repository: https://github.com/empress/ember-cli-showdown
- Homepage: https://github.com/empress/ember-cli-showdown#readme
- Issues: https://github.com/empress/ember-cli-showdown/issues
- npm.io page: https://npm.io/package/ember-cli-showdown

## Dependencies (3)

- [showdown](https://npm.io/package/showdown.md) ^2.1.0
- [decorator-transforms](https://npm.io/package/decorator-transforms.md) ^2.2.2
- [@embroider/addon-shim](https://npm.io/package/@embroider/addon-shim.md) ^1.8.9

## Alternatives

- [@mdxeditor/editor](https://npm.io/package/@mdxeditor/editor.md) — 962.4K weekly downloads
- [mmdb-lib](https://npm.io/package/mmdb-lib.md) — 680.9K weekly downloads
- [playcanvas](https://npm.io/package/playcanvas.md) — 36.2K weekly downloads
- [@glw907/cairn-cms](https://npm.io/package/@glw907/cairn-cms.md) — 967 weekly downloads
- [markdown-to-confluence](https://npm.io/package/markdown-to-confluence.md) — 103 weekly downloads

## Recent versions

- 10.0.0 (latest) — 2026-06-23
- 9.0.2 — 2025-09-26
- 9.0.1 — 2024-03-08
- 9.0.0 — 2024-02-07
- 8.1.0 — 2024-02-07
- 8.0.0 — 2024-01-19
- 7.0.0 — 2023-07-02
- 6.0.1 — 2021-12-07
- 6.0.0 — 2021-09-15
- 5.0.0 — 2021-09-15
- 4.5.0 — 2020-04-04
- 4.4.4 — 2018-06-20
- 4.4.3 — 2018-06-20
- 4.4.2 — 2018-05-17
- 4.4.1 — 2018-05-17
- … 43 more at https://npm.io/package/ember-cli-showdown/versions

## README

# ember-cli-showdown

[![Ember Observer Score](http://emberobserver.com/badges/ember-cli-showdown.svg)](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.28 or above
- Embroider or ember-auto-import v2

## Installation

- `ember install ember-cli-showdown`

## Usage

Passing a markdown string inline:

```handlebars
<MarkdownToHtml @markdown="#Markdown is cool [link](http://emberjs.com)" />
```

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

You can also pass a bound value:

```handlebars
<MarkdownToHtml @markdown={{postContent}} />
```

### Showdown Options

You can use [configuration settings from Showdown][showdown-config]:

```handlebars
<MarkdownToHtml
  @markdown={{postContent}}
  @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;
};
```

### Showdown Extensions

You can load [Showdown Extensions](https://github.com/showdownjs/showdown/wiki/extensions) by specifying the
"extensions" property when initializing your component:

```handlebars
<MarkdownToHtml @markdown={{postContent}} @extensions={{myExtensionList}} />
```

```handlebars
<MarkdownToHtml @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:

```js
// app/initializers/register-showdown-extensions.js
import showdown from "showdown";

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

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 `<MarkdownToHtml />`.

## 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).

---
_Source: https://npm.io/package/ember-cli-showdown · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._