Class Renderer<T>

constructor

• new Renderer<T>(options?): Renderer<T>

• Type Parameters

  • T = never

  Parameters

  • Optional options: MarkedOptions

  Returns Renderer<T>

options

blockquote

• blockquote(this, quote): string | T

• Parameters

  • this: RendererThis

  • quote: string

  Returns string | T

br

• br(this): string | T

• Parameters

  • this: RendererThis

  Returns string | T

checkbox

• checkbox(this, checked): string | T

• Parameters

  • this: RendererThis

  • checked: boolean

  Returns string | T

code

• code(this, code, language, isEscaped): string | T

• Parameters

  • this: RendererThis

  • code: string

  • language: undefined | string

  • isEscaped: boolean

  Returns string | T

codespan

• codespan(this, code): string | T

• Parameters

  • this: RendererThis

  • code: string

  Returns string | T

del

• del(this, text): string | T

• Parameters

  • this: RendererThis

  • text: string

  Returns string | T

em

• em(this, text): string | T

• Parameters

  • this: RendererThis

  • text: string

  Returns string | T

heading

• heading(this, text, level, raw, slugger): string | T

• Parameters

  • this: RendererThis

  • text: string

  • level: 2 | 1 | 3 | 4 | 5 | 6

  • raw: string

  • slugger: Slugger

  Returns string | T

hr

• hr(this): string | T

• Parameters

  • this: RendererThis

  Returns string | T

html

• html(this, html): string | T

• Parameters

  • this: RendererThis

  • html: string

  Returns string | T

image

• image(this, href, title, text): string | T

• Parameters

  • this: RendererThis

  • href: null | string

  • title: null | string

  • text: string

  Returns string | T

link

• link(this, href, title, text): string | T

• Parameters

  • this: RendererThis

  • href: null | string

  • title: null | string

  • text: string

  Returns string | T

list

• list(this, body, ordered, start): string | T

• Parameters

  • this: RendererThis

  • body: string

  • ordered: boolean

  • start: number

  Returns string | T

listitem

• listitem(this, text, task, checked): string | T

• Parameters

  • this: RendererThis

  • text: string

  • task: boolean

  • checked: boolean

  Returns string | T

paragraph

• paragraph(this, text): string | T

• Parameters

  • this: RendererThis

  • text: string

  Returns string | T

strong

• strong(this, text): string | T

• Parameters

  • this: RendererThis

  • text: string

  Returns string | T

table

• table(this, header, body): string | T

• Parameters

  • this: RendererThis

  • header: string

  • body: string

  Returns string | T

tablecell

• tablecell(this, content, flags): string | T

• Parameters

  • this: RendererThis

  • content: string

  • flags: {
        align: null | "center" | "left" | "right";
        header: boolean;
    }

    • align: null | "center" | "left" | "right"

    • header: boolean

  Returns string | T

tablerow

• tablerow(this, content): string | T

• Parameters

  • this: RendererThis

  • content: string

  Returns string | T

text

• text(this, text): string | T

• Parameters

  • this: RendererThis

  • text: string

  Returns string | T