Optional baseOptional breaksEnable GFM line breaks. This option requires the gfm option to be true.
Optional getA function that can be used to get the language for a block of code or allow different aliases.
The language to use
Optional gfmEnable GitHub flavored markdown.
Optional headerInclude an id attribute when emitting headings.
Optional headerSet the prefix for header tag ids.
Optional highlightThis function is mostly used if you'd like to be able to have the code
highlighted via dangerouslySetInnerHTML so that the code can be highlighted
in node environments.
the html to dangerously set within a <code> tag
Optional highlightA function that should highlight all the code within an HTMLElement. This
should normally just be something like Prism.highlightElement or
HighlightJS.highlightElement.
Optional langSet the prefix for code block classes.
Optional mangleMangle autolinks (email@domain.com).
Optional pedanticConform to obscure parts of markdown.pl as much as possible. Don't fix any of the original markdown bugs or poor behavior.
Optional rendererType: object Default: new Renderer()
An object containing functions to render tokens to HTML.
Optional silentShows an HTML error message when rendering fails.
Optional smartUse smarter list behavior than the original markdown. May eventually be default with the old behavior moved into pedantic.
Optional smartypantsUse "smart" typograhic punctuation for things like quotes and dashes.
Optional tokenizerThe tokenizer defines how to turn markdown text into tokens.
Optional walkThe 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.
Optional xhtmlGenerate closing slash for self-closing tags (
instead of
)
Generated using TypeDoc
A prefix URL for any relative link.