Marked.marked | /mod.ts | gfm@0.2.3

namespace Marked.marked

import { Marked } from "https://deno.land/x/gfm@0.2.3/mod.ts";
const { marked } = Marked;

function Marked.marked

import { Marked } from "https://deno.land/x/gfm@0.2.3/mod.ts";
const { marked } = Marked;

marked(src: string, options: marked.MarkedOptions & { async: true; }): Promise<string>

Compiles markdown to HTML asynchronously.

marked(src: string, options?: marked.MarkedOptions): string

Compiles markdown to HTML synchronously.

marked(src: string, callback: (error: any, parseResult: string) => void): void

Compiles markdown to HTML asynchronously with a callback.

marked(

src: string,

options: marked.MarkedOptions,

callback: (error: any, parseResult: string) => void,

): void

Compiles markdown to HTML asynchronously with a callback.

Compiles markdown to HTML asynchronously.

Parameters

src: string

String of markdown source to be compiled

options: marked.MarkedOptions & { async: true; }

Hash of options, having async: true

Returns

Promise<string>

Promise of string of compiled HTML

Compiles markdown to HTML synchronously.

Parameters

src: string

String of markdown source to be compiled

optional

options: marked.MarkedOptions

Optional hash of options

Returns

string

String of compiled HTML

Compiles markdown to HTML asynchronously with a callback.

Parameters

src: string

String of markdown source to be compiled

callback: (error: any, parseResult: string) => void

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

Returns

void

Compiles markdown to HTML asynchronously with a callback.

Parameters

src: string

String of markdown source to be compiled

options: marked.MarkedOptions

Hash of options

callback: (error: any, parseResult: string) => void

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

Returns

void