Interface MarkedOptions

Index

Properties

Methods

Properties

optional public breaks?: boolean

Enable GFM line breaks. This option requires the gfm option to be true.

optional public gfm?: boolean

Enable GitHub flavored markdown.

optional public langPrefix?: string

Set the prefix for code block classes.

optional public pedantic?: boolean

Conform to obscure parts of markdown.pl as much as possible. Don't fix any of the original markdown bugs or poor behavior.

optional public sanitize?: boolean

Sanitize the output. Ignore any HTML that has been input.

optional public silent?: boolean

Shows an HTML error message when rendering fails.

optional public smartLists?: boolean

Use smarter list behavior than the original markdown. May eventually be default with the old behavior moved into pedantic.

optional public smartypants?: boolean

Use "smart" typograhic punctuation for things like quotes and dashes.

optional public tables?: boolean

Enable GFM tables. This option requires the gfm option to be true.

Methods

optional public highlight(code: string, lang: string, callback?: Function): string

A function to highlight code blocks. The function takes three arguments: code, lang, and callback.

Parameters

  • code: string
  • lang: string
  • callback?: Function optional

Returns

string