@lakea/gravity-markdown-adapter-marked

@lakea/gravity-markdown-adapter-marked

An adapter for GrMarkdown using marked as implementation.

Installation

Install the library using NPM:

npm install @lakea/gravity-markdown-adapter-marked marked --save

Next, create a new file, markdown-adapter-root.module.ts which exposes an Angular's module with a default configuration.

import {NgModule} from '@angular/core';
import {GrMarkdown} from '@lakea/gravity/cdk';
import {GrMarkdownAdapterMarked} from '@lakea/gravity-markdown-adapter-marked';

@NgModule({
  providers: [
    {
      provide: GrMarkdown,
      useClass: GrMarkdownAdapterMarked,
    },
  ],
})
export class MarkdownAdapterRootModule {}

Import MarkdownAdapterRootModule to application root module like app.module.ts.

You should import the MarkdownAdapterRootModule once in your root module.

The MarkdownAdapterRootModule provide the adapter implementation for GrMarkdown.

---

Creating your own adapter

Create your adapter implementation class extending GrMarkdown abstraction:

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

import {GrMarkdown} from '@lakea/gravity/cdk';

@Injectable()
export class GrMarkdownAdapter extends GrMarkdown {
  constructor() {
    super();
  }

  public toHtml(value: string): string {
    // YOUR IMPLEMENTATION
  }
}

So, provide it on your application root module (maybe app.module.ts), like this:

  providers: [
    {
      provide: GrMarkdown,
      useClass: GrMarkdownAdapter,
    }
  ]