# angular-markdown-filter

> Markdown filter for Angular

Latest version **1.3.2** (published 2015-09-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install angular-markdown-filter
pnpm add angular-markdown-filter
yarn add angular-markdown-filter
bun add angular-markdown-filter
```

## 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.3.2 |
| Published | 2015-09-04 |
| First published | 2015-09-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 (+3 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 22 |
| Author | Victor Pegado |
| Maintainers | vpegado |
| Keywords | angular, markdown, filter, showdown |

## Links

- npm: https://www.npmjs.com/package/angular-markdown-filter
- Repository: https://github.com/vpegado/angular-markdown-filter
- Homepage: https://github.com/vpegado/angular-markdown-filter#readme
- Issues: https://github.com/vpegado/angular-markdown-filter/issues
- npm.io page: https://npm.io/package/angular-markdown-filter

## Dependencies (1)

- [showdown](https://npm.io/package/showdown.md) ^1.2.3

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

- 1.3.2 (latest) — 2015-09-04
- 1.3.1 — 2015-09-04
- 1.3.0 — 2015-09-04

## README

angular-markdown-filter
=======================

Markdown filter for Angular

## Installation
```bash
# As a bower component:
$ bower install angular-markdown-filter

# As a npm package:
$ npm install angular-markdown-filter
```
It's recomended to also use [ngSanitize](https://docs.angularjs.org/api/ngSanitize) if you plan to bind the output using [ngBindHtml](https://docs.angularjs.org/api/ng/directive/ngBindHtml) to pervent [XSS](https://www.owasp.org/index.php/Cross-site_Scripting_%28XSS%29).
```bash
$ bower install angular-sanitize
```

## Import dependencies
```html
<script src="bower_components/showdown/compressed/showdown.js"></script>
<script src="bower_components/angular-markdown-filter/markdown.js"></script>
<!-- Optional: -->
<script src="bower_components/angular-sanitize/angular-sanitize.js"></script>
```
```javascript
angular.module('myApp', [
  'ngSanitize', // Optional
  'markdown'
]);
```

## Configuration
The underlying Showdown converter can be configured through the `markdown` provider
```javascript
angular.module('markdown')
  .config(function(markdownProvider) {
    markdownProvider.config({
      extensions: ['table']
    });
  });
``` 
see the [Showdown documentation](https://github.com/showdownjs/showdown#creating-markdown-extensions)
for details on how to create extensions.

## Usage
```javascript
angular.module('myApp')
  // Optional Config
  .config(function ($compileProvider) {
    // Add optional support for custom schema links: "herp://" and "derp://"
    $compileProvider.aHrefSanitizationWhitelist(/^\s*(herp|derp):/);
  })
  .controller('MainCtrl', function ($scope) {
    $scope.text = '# Heading 1\n- [Link](http://example.com)\n- [Custom Link 1](herp://is.this.working?)\n- [Custom Link 2](derp://is.this.working?)';
  });
```
```html
<div class="container" ng-bind-html="text | markdown"></div>
```

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