Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • MarkedOptions

Index

Properties

Optional baseUrl

baseUrl: undefined | string

A prefix URL for any relative link.

Optional breaks

breaks: undefined | false | true

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

Optional gfm

gfm: undefined | false | true

Enable GitHub flavored markdown.

Optional headerIds

headerIds: undefined | false | true

Include an id attribute when emitting headings.

Optional headerPrefix

headerPrefix: undefined | string

Set the prefix for header tag ids.

Optional langPrefix

langPrefix: undefined | string

Set the prefix for code block classes.

Optional mangle

mangle: undefined | false | true

Mangle autolinks (email@domain.com).

Optional pedantic

pedantic: undefined | false | true

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

Optional renderer

renderer: Renderer

Type: object Default: new Renderer()

An object containing functions to render tokens to HTML.

Optional sanitize

sanitize: undefined | false | true

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

Optional silent

silent: undefined | false | true

Shows an HTML error message when rendering fails.

Optional smartLists

smartLists: undefined | false | true

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

Optional smartypants

smartypants: undefined | false | true

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

Optional tables

tables: undefined | false | true

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

Optional xhtml

xhtml: undefined | false | true

Generate closing slash for self-closing tags (
instead of
)

Methods

Optional highlight

  • highlight(code: string, lang: string, callback?: undefined | function): string
  • A function to highlight code blocks. The function takes three arguments: code, lang, and callback.

    Parameters

    • code: string
    • lang: string
    • Optional callback: undefined | function

    Returns string

Optional sanitizer

  • sanitizer(html: string): string
  • Optionally sanitize found HTML with a sanitizer function.

    Parameters

    • html: string

    Returns string

Generated using TypeDoc