Function parse

  • parse(src, callback): void

  • Compiles markdown to HTML.

    Parameters

    • src: string

      String of markdown source to be compiled

    • callback: ((error, parseResult) => void)

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

        • (error, parseResult): void

        • Parameters

          • error: any
          • parseResult: string

          Returns void

    Returns void

    String of compiled HTML

  • parse(src, options): Promise<string>

  • Compiles markdown to HTML asynchronously.

    Parameters

    • src: string

      String of markdown source to be compiled

    • options: MarkedOptions & {
          async: true;
      }

      Hash of options having async: true

    Returns Promise<string>

    Promise of string of compiled HTML

  • parse(src, options?): string

  • Compiles markdown to HTML synchronously.

    Parameters

    • src: string

      String of markdown source to be compiled

    • Optional options: MarkedOptions

      Optional hash of options

    Returns string

    String of compiled HTML

  • parse(src, options, callback): void

  • Compiles markdown to HTML synchronously.

    Parameters

    • src: string

      String of markdown source to be compiled

    • options: MarkedOptions

      Optional hash of options

    • callback: ((error, parseResult) => void)

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

        • (error, parseResult): void

        • Parameters

          • error: any
          • parseResult: string

          Returns void

    Returns void

    String of compiled HTML

Settings

Member Visibility

Theme