@ng-util/markdown
TypeScript icon, indicating that this package has built-in type declarations

17.0.1 • Public • Published

@ng-util/markdown

Vditor for Angular.

NPM version Build Status codecov Dependency Status prettier GitHub license

Demo

Usage

Installation

Install from npm repository:

npm install @ng-util/markdown --save

Sample

Include NuMarkdownModule in Main Module and Feature Modules where you want to use the editor component.(eg: app.module.ts):

import { NgModule } from '@angular/core';
import { NuMarkdownModule } from '@ng-util/markdown';

@NgModule({
  imports: [
    NuMarkdownModule // And use `provideNuMarkdownConfig` to modify the global configuration
  ],
})
export class AppModule { }

Create markdown options in component.

import { Component } from '@angular/core';

@Component({
  selector: 'app-root',
  template: `<nu-markdown [(ngModel)]="value"></nu-markdown>`,
})
export class DemoComponent {
  value = '# Title';
}

Preview

You can use nu-markdown-preview component to render a Markdown preview effect (no editing).

<nu-markdown-preview value="# Title"></nu-markdown-preview>

API

nu-markdown

Property Description Type Default
[options] Equar IOptions any -
[disabled] Disabled of markdown editor boolean false
[delay] Delay init monaco editor, unit: ms number 0
(ready) Ready event EventEmitter<any> -

nu-markdown-preview

Property Description Type Default
[options] Equar IOptions any -
[delay] Delay init monaco editor, unit: ms number 0
(ready) Ready event EventEmitter<string> -

License

The MIT License (see the LICENSE file for the full text)

Package Sidebar

Install

npm i @ng-util/markdown

Weekly Downloads

461

Version

17.0.1

License

MIT

Unpacked Size

68.4 kB

Total Files

21

Last publish

Collaborators

  • cipchk