Interface MarkedStatic

Index

Call signatures

Methods

Call signatures

(src: string, callback: Function): string

Compiles markdown to HTML.

Parameters

  • src: string

    String of markdown source to be compiled

  • callback: Function

    Function called when the markdownString has been fully parsed when using async highlighting

Returns

string

String of compiled HTML

(src: string, options?: MarkedOptions, callback?: Function): string

Compiles markdown to HTML.

Parameters

  • src: string

    String of markdown source to be compiled

  • options?: MarkedOptions optional

    Hash of options

  • callback?: Function optional

    Function called when the markdownString has been fully parsed when using async highlighting

Returns

string

String of compiled HTML

Methods

public lexer(src: string, options?: MarkedOptions): Array<any>

Parameters

  • src: string

    String of markdown source to be compiled

  • options?: MarkedOptions optional

    Hash of options

Returns

Array<any>

public parse(src: string, callback: Function): string

Compiles markdown to HTML.

Parameters

  • src: string

    String of markdown source to be compiled

  • callback: Function

    Function called when the markdownString has been fully parsed when using async highlighting

Returns

string

String of compiled HTML

public parse(src: string, options?: MarkedOptions, callback?: Function): string

Compiles markdown to HTML.

Parameters

  • src: string

    String of markdown source to be compiled

  • options?: MarkedOptions optional

    Hash of options

  • callback?: Function optional

    Function called when the markdownString has been fully parsed when using async highlighting

Returns

string

String of compiled HTML

public parser(src: Array<any>, options?: MarkedOptions): string

Parameters

  • src: Array<any>
  • options?: MarkedOptions optional

    Hash of options

Returns

string

public setOptions(options: MarkedOptions)

Sets the default options.

Parameters