Configuration

Streamdown can be configured to suit your needs. This guide will walk you through the available options and how to configure them.

Core Props

Styling Props

CDN Props

Plugin Props

Default Rehype Plugins:

• rehype-raw - HTML support
• rehype-sanitize - XSS protection and safe HTML rendering
• rehype-harden - Security hardening (allows all image and link prefixes, data images enabled)

Default Remark Plugins:

• remark-gfm - GitHub Flavored Markdown

Math rendering and CJK support require installing separate plugins. See Mathematics and CJK Language Support.

Feature-Specific Props

Mermaid Options

The mermaid prop accepts an object with the following properties:

Advanced Props

The controls prop can be configured granularly:

<Streamdown
  controls={{
    table: true, // Show table download button
    code: true, // Show code copy button
    mermaid: {
      download: true, // Show mermaid download button
      copy: true, // Show mermaid copy button
      fullscreen: true, // Show mermaid fullscreen button
      panZoom: true, // Show mermaid pan/zoom controls
    },
  }}
>
  {markdown}
</Streamdown>

Remend Options

The remend prop configures which Markdown completions are performed during streaming. All options default to true when not specified. Set an option to false to disable that completion:

<Streamdown
  remend={{
    links: false, // Disable link completion
    katex: false, // Disable KaTeX completion
  }}
>
  {markdown}
</Streamdown>