Skip to content

Markdown

Last updated:

Configure how Mermaid diagrams appear in the Markdown preview at Settings > Tools > Mermaid Studio > Markdown.

Markdown diagram settings

Disable Mermaid contributions to Markdown preview

Section titled “Disable Mermaid contributions to Markdown preview”

The Enable Mermaid in Markdown preview toggle controls whether Mermaid Studio renders diagrams inside the platform Markdown preview at all. With the toggle off, ```mermaid (and ```mmd) fences stay rendered as plain code blocks by the platform Markdown plugin, exactly as if Mermaid Studio weren’t installed. This is useful when you’d rather use a different Mermaid renderer alongside the plugin, or when you only need the Mermaid editor support (highlighting, completion, refactoring) without the in-Markdown preview overhead.

When you toggle the setting, every open Markdown editor hot-swaps in place with no IDE restart needed, and your scroll position and tab focus survive.

By default, rendered diagrams are shown inside a container with a subtle background. Enable Show diagrams inline to remove the container background, letting diagrams blend directly into the page.

Inline display in Markdown preview

Large diagrams can dominate the preview and make it difficult to read surrounding content. Use the size limits to constrain diagram dimensions:

SettingDefaultDescription
Limit maximum widthOffWhen enabled, constrains diagram width to the specified pixel value
Maximum width1200 pxMaximum width in pixels (100 - 20,000)
Limit maximum heightOffWhen enabled, constrains diagram height to the specified pixel value
Maximum height800 pxMaximum height in pixels (100 - 20,000)

Diagrams that exceed the configured limits are scaled down proportionally. Diagrams smaller than the limits are not affected.

Settings take effect immediately in all open Markdown previews.