function html | Bun module | Bun

Render markdown to an HTML string.

The markdown string or buffer to render

Parser options

An HTML string

const html = Bun.markdown.html("# Hello **world**");
// "Hello world\n"

// With options
const html = Bun.markdown.html("## Hello", { headings: { ids: true } });
// 'Hello\n'

Represents a raw buffer of binary data, which is used to store data for the different typed arrays. ArrayBuffers cannot be read from or written to directly, but can be passed to a typed array or DataView Object to interpret the raw buffer as needed.

Read-only. The length of the ArrayBuffer (in bytes).

Resizes the ArrayBuffer to the specified size (in bytes).

MDN

Resize an ArrayBuffer in-place.

Returns a section of an ArrayBuffer.

Creates a new ArrayBuffer with the same byte content as this buffer, then detaches this buffer.

MDN

Creates a new non-resizable ArrayBuffer with the same byte content as this buffer, then detaches this buffer.

MDN

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.