WebCola
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • MarkedStatic

Callable

  • __call(src: string, callback: Function): string
  • __call(src: string, options?: MarkedOptions, 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

  • Compiles markdown to HTML.

    Parameters

    • src: string

      String of markdown source to be compiled

    • Optional options: MarkedOptions

      Hash of options

    • Optional callback: Function

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

    Returns string

    String of compiled HTML

Index

Properties

Parser

Parser: object

Type declaration

Renderer

Renderer: object

Type declaration

  • constructor: function
    • Returns __type

Methods

lexer

  • Parameters

    • src: string

      String of markdown source to be compiled

    • Optional options: MarkedOptions

      Hash of options

    Returns any[]

parse

  • parse(src: string, callback: Function): string
  • parse(src: string, options?: MarkedOptions, 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

  • Compiles markdown to HTML.

    Parameters

    • src: string

      String of markdown source to be compiled

    • Optional options: MarkedOptions

      Hash of options

    • Optional callback: Function

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

    Returns string

    String of compiled HTML

parser

  • Parameters

    Returns string

setOptions

  • Sets the default options.

    Parameters

    Returns MarkedStatic

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc