Giter VIP home page Giter VIP logo

molecule-markdown's Introduction

Molecule Markdown

CircleCI Codecov npm (scoped)

Molecule Markdown provides you an Angular directive '# Title'|md and a corresponding service, MarkdownService, which allows you to provide any markdown parser you wish. On the other hand, you need to provide a subclass for it in order to MarkdownPipe.

Example

@NgModule({
  import: [MarkdownModule],
  declarations: [MyComponent],
  providers: [{
    provide: MarkdownService,
    useClass: YourMarkdownService
  }]
})
export class MyModule {}

@Component({
  template: '{{myMarkdownText|md}}'
})
export class MyComponent {
  @Input() public myMarkdownText: string;
}

Using Marked

@Injectable()
export class MarkdedService extends MarkdownService {
  constructor() {
    marked.setOptions({ /* configuration options */ });
  }
  public markdownToHtml(markdown: string, ...args: any[]): string {
    return marked(markdown, options);
  }
}

Using Markdown It

@Injectable()
export class MarkdownItService extends MarkdownService {
  private readonly markdownIt: MarkdownIt;
  constructor() {
    this.markdownIt = new MarkdownIt();
  }
  public markdownToHtml(markdown: string, ...args: any[]): string {
    return this.markdownIt.render(markdown);
  }
}

Installation

$ npm install --save @molecule/markdown

Author

Valentin Knabel, @vknabel, [email protected]

License

@molecule/markdown is available under the MIT license.

molecule-markdown's People

Contributors

vknabel avatar

Watchers

James Cloos avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.