Interface MarkedOptions

interface MarkedOptions {
    async?: boolean;
    baseUrl?: string;
    breaks?: boolean;
    gfm?: boolean;
    headerIds?: boolean;
    headerPrefix?: string;
    hooks?: {
        postprocess?: ((html) => string);
        preprocess?: ((markdown) => string);
    };
    langPrefix?: string;
    mangle?: boolean;
    pedantic?: boolean;
    renderer?: Renderer<never>;
    sanitize?: boolean;
    silent?: boolean;
    smartLists?: boolean;
    smartypants?: boolean;
    tokenizer?: Tokenizer<never>;
    walkTokens?: ((token) => void);
    xhtml?: boolean;
    highlight?(code, lang, callback?): string | void;
    sanitizer?(html): string;
}

Hierarchy

Properties

async? baseUrl? breaks? gfm? headerIds? headerPrefix? hooks? langPrefix? mangle? pedantic? renderer? sanitize? silent? smartLists? smartypants? tokenizer? walkTokens? xhtml?

Methods

highlight? sanitizer?

Properties

Optional async

async?: boolean

True will tell marked to await any walkTokens functions before parsing the tokens and returning an HTML string.

Optional baseUrl

baseUrl?: string

A prefix URL for any relative link.

Optional breaks

breaks?: boolean

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

Optional gfm

gfm?: boolean

Enable GitHub flavored markdown.

Optional headerIds

headerIds?: boolean

Include an id attribute when emitting headings.

Optional headerPrefix

headerPrefix?: string

Set the prefix for header tag ids.

Optional hooks

hooks?: {
    postprocess?: ((html) => string);
    preprocess?: ((markdown) => string);
}

Hooks are methods that hook into some part of marked. preprocess is called to process markdown before sending it to marked. postprocess is called to process html after marked has finished parsing.

Type declaration

  • Optional postprocess?: ((html) => string)
      • (html): string

      • Parameters

        • html: string

        Returns string

  • Optional preprocess?: ((markdown) => string)
      • (markdown): string

      • Parameters

        • markdown: string

        Returns string

Optional langPrefix

langPrefix?: string

Set the prefix for code block classes.

Optional mangle

mangle?: boolean

Mangle autolinks (email@domain.com).

Optional pedantic

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 renderer

renderer?: Renderer<never>

Type: object Default: new Renderer()

An object containing functions to render tokens to HTML.

Optional sanitize

sanitize?: boolean

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

Optional silent

silent?: boolean

Shows an HTML error message when rendering fails.

Optional smartLists

smartLists?: boolean

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

Optional smartypants

smartypants?: boolean

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

Optional tokenizer

tokenizer?: Tokenizer<never>

The tokenizer defines how to turn markdown text into tokens.

Optional walkTokens

walkTokens?: ((token) => void)

The walkTokens function gets called with every token. Child tokens are called before moving on to sibling tokens. Each token is passed by reference so updates are persisted when passed to the parser. The return value of the function is ignored.

Type declaration

    • (token): void

    • Parameters

      Returns void

Optional xhtml

xhtml?: boolean

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

Methods

Optional highlight

  • highlight(code, lang, callback?): string | void

  • A function to highlight code blocks. The function can either be synchronous (returning a string) or asynchronous (callback invoked with an error if any occurred during highlighting and a string if highlighting was successful)

    Parameters

    • code: string
    • lang: string
    • Optional callback: ((error, code?) => void)
        • (error, code?): void

        • Parameters

          • error: any
          • Optional code: string

          Returns void

    Returns string | void

Optional sanitizer

  • sanitizer(html): string

  • Optionally sanitize found HTML with a sanitizer function.

    Parameters

    • html: string

    Returns string

Settings

Member Visibility

Theme

On This Page

asyncbaseUrlbreaksgfmheaderIdsheaderPrefixhookslangPrefixmanglepedanticrenderersanitizesilentsmartListssmartypantstokenizerwalkTokensxhtmlhighlightsanitizer