markdown.Options

interface Options

• autolinks?: boolean | { email: boolean; url: boolean; www: boolean }

  Enable autolinks. Pass true to enable all autolink types (URL, WWW, email), or an object to enable individually.

  // Enable all autolinks
  { autolinks: true }
  // Enable only URL and email autolinks
  { autolinks: { url: true, email: true } }

• collapseWhitespace?: boolean

  Collapse whitespace in text content. Default: false.

• hardSoftBreaks?: boolean

  Treat soft line breaks as hard line breaks. Default: false.

• headings?: boolean | { autolink: boolean; ids: boolean }

  Configure heading IDs and autolink headings. Pass true to enable both heading IDs and autolink headings, or an object to configure individually.

  // Enable both heading IDs and autolink headings
  { headings: true }
  // Enable only heading IDs
  { headings: { ids: true } }

• latexMath?: boolean

  Enable LaTeX math ($inline$ and $$display$$). Default: false.

• noHtmlBlocks?: boolean

  Disable HTML blocks. Default: false.

• noHtmlSpans?: boolean

  Disable inline HTML spans. Default: false.

• noIndentedCodeBlocks?: boolean

  Disable indented code blocks. Default: false.

• permissiveAtxHeaders?: boolean

  Allow ATX headers without a space after #. Default: false.

• strikethrough?: boolean

  Enable GFM strikethrough (~~text~~). Default: true.

• tables?: boolean

  Enable GFM tables. Default: true.

• tagFilter?: boolean

  Enable the GFM tag filter, which replaces < with < for disallowed HTML tags (e.g. <script>, <style>, <iframe>). Default: false.

• tasklists?: boolean

  Enable GFM task lists (- [x] item). Default: true.

• underline?: boolean

  Enable underline syntax (__text__ renders as <u> instead of <strong>). Default: false.

• wikiLinks?: boolean

  Enable wiki-style links ([[target]] or [[target|label]]). Default: false.