# @beligh/angular-markdown

> Source @ [https://github.com/dimpu/angular2-markdown]()

Latest version **1.3.3** (published 2017-01-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install @beligh/angular-markdown
pnpm add @beligh/angular-markdown
yarn add @beligh/angular-markdown
bun add @beligh/angular-markdown
```

## 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.3 |
| Published | 2017-01-26 |
| First published | 2017-01-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 16 |
| Known vulnerabilities | 0 (+21 in 4 direct dependencies) |
| Install scripts | no |
| Maintainers | beligh |

## Links

- npm: https://www.npmjs.com/package/@beligh/angular-markdown
- npm.io page: https://npm.io/package/@beligh/angular-markdown

## Dependencies (16)

- [rxjs](https://npm.io/package/rxjs.md) ^5.0.3
- [marked](https://npm.io/package/marked.md) ^0.3.6
- [core-js](https://npm.io/package/core-js.md) ^2.4.1
- [prismjs](https://npm.io/package/prismjs.md) ^1.5.1
- [zone.js](https://npm.io/package/zone.js.md) ^0.7.2
- [ts-helpers](https://npm.io/package/ts-helpers.md) ^1.1.1
- [@angular/core](https://npm.io/package/@angular/core.md) ^2.3.1
- [@angular/http](https://npm.io/package/@angular/http.md) ^2.3.1
- [@types/marked](https://npm.io/package/@types/marked.md) 0.0.28
- [@angular/forms](https://npm.io/package/@angular/forms.md) ^2.3.1
- [@types/prismjs](https://npm.io/package/@types/prismjs.md) ^1.4.18
- [@angular/common](https://npm.io/package/@angular/common.md) ^2.3.1
- [@angular/router](https://npm.io/package/@angular/router.md) ^3.3.1
- [@angular/compiler](https://npm.io/package/@angular/compiler.md) ^2.3.1
- [@angular/platform-browser](https://npm.io/package/@angular/platform-browser.md) ^2.3.1
- [@angular/platform-browser-dynamic](https://npm.io/package/@angular/platform-browser-dynamic.md) ^2.3.1

## Recent versions

- 1.3.3 (latest) — 2017-01-26

## README

# Angular 2 Markdown
Source @ [https://github.com/dimpu/angular2-markdown]()


## Setup
```bash
npm i angular2-markdown --save
```

## How to use it
### app.module.js
```typescript
import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';

import { MarkdownModule } from 'angular2-markdown';
import { AppComponent } from '../src/app.component';

@NgModule({
  imports: [
    BrowserModule,
    MarkdownModule.forRoot(),
  ],
  declarations: [AppComponent],
  bootstrap: [AppComponent],
})

```

### app.component.html
```html
 <div Markdown>
    ### your markdown code
 </div>

or use angular component

<markdown>
    ### your markdown code
</markdown>

// to load from remote url

<div Markdown path="/path/to/readme.md"></div>

// load remote source code with auto syantax helight.

<markdown path="/path/to/code.cpp"></markdown>

<markdown path="/path/to/code.java"></markdown>
```

## Example

You can found the working example inside the `src/app/demo directory`.

```
git clone https://github.com/dimpu/angular2-markdown.git

npm i

ng serve
```
now you should see working example at [http://localhost:4200]()

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