# markdown-to-html-pipe

> Angular Pipe that transforms a markdown string to HTML

Latest version **1.2.5** (published 2018-12-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install markdown-to-html-pipe
pnpm add markdown-to-html-pipe
yarn add markdown-to-html-pipe
bun add markdown-to-html-pipe
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.5 |
| Published | 2018-12-13 |
| First published | 2016-08-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 7.5 KB |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 39 |
| Author | Conclurer GmbH |
| Maintainers | aaronczichon, fhafner, jensreiner, marvinscharle, ringrazor, vknabel |
| Keywords | angular2, markdown, pipe, html |

## Links

- npm: https://www.npmjs.com/package/markdown-to-html-pipe
- Repository: https://github.com/conclurer/markdown-to-html-pipe
- Homepage: https://github.com/conclurer/markdown-to-html-pipe#readme
- Issues: https://github.com/conclurer/markdown-to-html-pipe/issues
- npm.io page: https://npm.io/package/markdown-to-html-pipe

## Dependencies (2)

- [marked](https://npm.io/package/marked.md) ^0.x
- [@types/marked](https://npm.io/package/@types/marked.md) ^0.0.27

## Alternatives

- [@tsparticles/shape-image](https://npm.io/package/@tsparticles/shape-image.md) — 303.7K weekly downloads
- [@tsparticles/shape-line](https://npm.io/package/@tsparticles/shape-line.md) — 233.7K weekly downloads
- [stringify-attributes](https://npm.io/package/stringify-attributes.md) — 58.6K weekly downloads
- [mobile-drag-drop](https://npm.io/package/mobile-drag-drop.md) — 46.3K weekly downloads
- [@comunica/actor-rdf-parse-html](https://npm.io/package/@comunica/actor-rdf-parse-html.md) — 29.2K weekly downloads

## Recent versions

- 1.2.5 (latest) — 2018-12-13
- 1.2.0-beta.1 (beta) — 2016-11-14
- 1.2.4 — 2017-11-30
- 1.2.3 — 2017-09-06
- 1.2.2 — 2017-07-20
- 1.2.1 — 2017-05-17
- 1.2.0 — 2016-11-14
- 1.1.2-beta.1 — 2016-11-14
- 1.1.2 — 2016-11-14
- 1.1.1 — 2016-10-20
- 1.1.0 — 2016-10-20
- 1.0.2 — 2016-09-14
- 1.0.1 — 2016-08-18
- 1.0.0 — 2016-08-17

## README

# Markdown To HTML Pipe

Converts a Markdown string, outputs HTML.

## Usage

```typescript
// example.module.ts
import {NgModule} from '@angular/core';
import {MarkdownToHtmlModule} from 'markdown-to-html-pipe';
import {ExampleComponent} from './example.component';

@NgModule({
  imports: [MarkdownToHtmlModule],
  declarations: [ExampleComponent]
})
export class ExampleModule {}
```

```typescript
// example.component.ts
import {Component} from '@angular/core';

@Component({
  selector: 'example',
  template: `<div [innerHTML]="content|MarkdownToHtml"></div>`
})
export class ExampleComponent {
  protected content: string = 'This will render **Markdown** content!';
}
```

Will be rendered as:

```html
<div>
  <p>This will render <strong>Markdown</strong> content!</p>
</div>
```

## Installation

Run

```
npm install --save markdown-to-html-pipe
```

---
_Source: https://npm.io/package/markdown-to-html-pipe · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
