interface Options | Bun module | Bun

Options for configuring the markdown parser.

By default, GFM extensions (tables, strikethrough, task lists) are enabled.

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 } }

Collapse whitespace in text content. Default: false.

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

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 } }

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

Disable HTML blocks. Default: false.

Disable inline HTML spans. Default: false.

Disable indented code blocks. Default: false.

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

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

Enable GFM tables. Default: true.