@ng-util/markdown
v17.0.1
Published
Vditor for Angular
Downloads
1,662
Maintainers
Readme
@ng-util/markdown
Vditor for Angular.
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)