ngx-md
Version:
[![Build Status][cirrus-ci-badge]][cirrus-ci-badge-url] [![npm][circleci-badge-url]][circleci-url] [![version][npm-badge-url]][npm-url] [![npm][license-badge-url]][license-url] [![npm][opencollective]][opencollective] [ • 7.44 kB
Markdown
[![Build Status][cirrus-ci-badge]][cirrus-ci-badge-url]
[![npm][circleci-badge-url]][circleci-url]
[![version][npm-badge-url]][npm-url]
[![npm][license-badge-url]][license-url]
[![npm][opencollective]][opencollective]
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fdimpu%2Fngx-md?ref=badge_shield)
Supports Angular2,4,5,6,7,12,18
Source @ [https://github.com/dimpu/ngx-md](https://github.com/dimpu/ngx-md)
1. [Getting Started](
2. [Installation instructions](
3. [Usage & Demo](
4. [Contributing](
5. [License](
ngx-md contains NgxMdModule for Angular.
Additionally we use [marked.js](https://github.com/chjj/marked/) and [prismjs](http://prismjs.com/) for this component.
Install `ngx-md` from `npm`:
```bash
npm install ngx-md --save
```
or using `yarn`:
```bash
yarn add ngx-md
```
- `angular-cli` — please refer to [Getting started with `angular-cli`](https://github.com/dimpu/ngx-md/tree/master/docs/getting-started/ng-cli.md)
- `angular-seed` — please refer to [Getting started with `angular-seed`](https://github.com/dimpu/ngx-md/tree/master/docs/getting-started/angular-seed.md)
- `system.js` (and [Angular 2 QuickStart](https://angular.io/docs/ts/latest/quickstart.html)) — please checkout [sample repository](https://github.com/dimpu/angular2-quickstart)
- `webpack` — you can view our demo page [source code](https://github.com/dimpu/ngx-md/tree/master/demo)
- `stackblitz` — sample available [here](https://stackblitz.com/edit/ngx-md-exmaple)
- `AoT` using `ngc` and `rollup` — please refer to [How to use `ngx-md` in Angular 2 with `AoT` compilation using `ngc` and `rollup`](https://github.com/dimpu/ngx-md/tree/master/docs/getting-started/aot.md)
Main source of API documentation and usage scenarios is available at [https://dimpu.github.io/ngx-md/](https://dimpu.github.io/ngx-md/).
Is very welcome! And remember, contribution is not only PRs and code, but any help with docs or helping other developers to solve issues are very appreciated! Thanks in advance!
This library has dependency on **HttpClientModule**. It should be always provided in your application.
```typescript
import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { NgxMdModule } from 'ngx-md';
import { HttpClientModule } from '@angular/common'
import { AppComponent } from '../src/app.component';
@NgModule({
imports: [
BrowserModule,
HttpClientModule,
NgxMdModule.forRoot(),
],
declarations: [AppComponent],
bootstrap: [AppComponent],
})
```
If you want syntax highlighting you need to import the prism css file.
Alternative 1: Import from cdn
```html
<head>
<meta charset="utf-8">
<base href="/">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="icon" type="image/x-icon" href="favicon.ico">
<link href="https://cdnjs.cloudflare.com/ajax/libs/prism/1.6.0/themes/prism.min.css" rel="stylesheet" />
</head>
```
Alternative 2: Download the css file (or copy it from `node_modules/prismjs/themes/`, place it somewhere in your src folder and import
```html
<link href="/css/prism.min.css" rel="stylesheet" />
```
Alternative 3: Include the prism css file in your sass style file
```css
@import 'prismjs/themes/prism.css';
```
To support sytnax helight for other langugage you need to include
```ts
// import 'prismjs/prism';
import 'prismjs/components/prism-c';
import 'prismjs/components/prism-cpp';
import 'prismjs/components/prism-csharp';
import 'prismjs/components/prism-css';
import 'prismjs/components/prism-diff';
import 'prismjs/components/prism-java';
import 'prismjs/components/prism-javascript';
import 'prismjs/components/prism-perl';
...
...
...
```
### app.component.html
```html
<div Markdown>
### your markdown code
</div>
<!-- or use angular component -->
<ngx-md>
### your markdown code
</ngx-md>
<!-- to load from remote URL -->
<div NgxMd [path]="'/path/to/readme.md'" (error)="errorHandler($event)" (loaded)="loadedHandler($event)" (rendered)="renderedHandler($event)"></div>
<!-- load remote source code with auto syntax highlighting -->
<ngx-md [path]="'/path/to/code.cpp'"></ngx-md>
<ngx-md [path]="'/path/to/code.java'"></ngx-md>
<!-- load remote source code from url stored in variable
(see additional details about variable binding in the next section) -->
<ngx-md [path]="urlVariable"></ngx-md>
<ngx-md [path]="urlVariable" (loaded)="onLoad($event)" (error)="onError($event)"></ngx-md>
```
Now, with >1.4.x you can bind a variable to the `markdown` component. To do so:
```typescript
@Component({
selector: 'app-root',
template: `
<textarea [(ngModel)]="textData"></textarea>
<ngx-md [data]="textData"></ngx-md>
`,
})
export class MyComp {
public textData = `
}
```
Marked can be customized/extended by accessing the renderer from the MarkdownService:
```typescript
import { NgxMdService } from 'ngx-md';
@Component({
selector='my-comp',
template: `
<ngx-md>
> Block
> quote
> here
</ngx-md>
`,
})
export class MyComp {
constructor(private _markdown: NgxMdService) {}
ngOnInit() {
this._markdown.renderer.blockquote = (quote: string) => {
return `<blockquote class="king-quote">${quote}</blockquote>`;
}
}
```
See [marked documentation](https://github.com/chjj/marked) for all renderer extension points.
You can find a working example inside the `demo` directory.
To serve it locally, run:
```bash
git clone https://github.com/dimpu/ngx-md.git
npm i
npm run demo.serve
```
- [x] Variable binding
- [x] Code refactor
- [x] Write more unit tests
- [x] Angular 5,6,7 support
- [ ] Angular schemantics support
- [ ] Module configuration for markdown settings
- [ ] Module configuration for prismjs settings
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fdimpu%2Fngx-md?ref=badge_large)
[]: https://api.cirrus-ci.com/github/dimpu/ngx-md.svg?branch=master
[]: https://api.cirrus-ci.com/github/dimpu/ngx-md
[]: https://opensource.org/licenses/MIT
[]: https://img.shields.io/npm/l/ngx-md.svg
[]: https://www.npmjs.com/package/ngx-md
[]: https://img.shields.io/npm/v/ngx-md.svg?style=flat
[]: https://circleci.com/gh/dimpu/ngx-md/master
[]: https://circleci.com/gh/dimpu/ngx-md/tree/master.svg?style=shield&
[]: https://github.com/dimpu/ngx-md
[]: https://david-dm.org/dimpu/ngx-md
[]: https://david-dm.org/dimpu/ngx-md/status.svg
[]: https://opencollective.com/ngx-md/tiers/backer/badge.svg?label=backer&color=brightgreen
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fdimpu%2Fngx-md?ref=badge_large)