Configuration Overview

Configure parsing, rendering, controls, security, and integrations.

Markdown accepts the complete Markdown source and renders a Comark document directly to Vue nodes.

Core options

PropTypeDefaultPurpose
contentstring''Markdown source to render
mode'streaming' | 'static''streaming'Enable completion and streaming UI state, or parse settled source unchanged
completionboolean | CompletionOptions | CompletionFunctiontrueConfigure, replace, or disable streaming completion
parserOptionsStreamMarkdownParserOptions{}Add Comark plugins or parser options
literalTagContentstring[]undefinedTreat configured custom-tag children as plain text
componentsMarkdownComponents{}Map native or custom tags to Vue components
dir'auto' | 'ltr' | 'rtl'undefinedConfigure text direction
enableAnimatebooleanfollows modeEnable enter animations
animationstring'fade-in'Select the enter animation
animationSplit'auto' | 'word' | 'char''auto'Select text animation granularity
animationDurationnumber | string180Set animation duration
animationStaggernumber40Maximum start-time spread within a streaming batch (ms)
caret'block' | 'circle'undefinedShow a streaming caret

Code, math, and diagram renderers are configured through extensions. Display, control, preview, security, theme, and locale options remain on Markdown or MarkdownProvider.

Streaming animation timing

animationDuration controls how long each entry animation lasts. animationStagger controls the maximum time spread between the first and last new words or characters in a received batch:

<Markdown
  :animation-duration="180"
  :animation-stagger="40"
  animation-split="auto"
/>

The default auto split animates Latin text by word and CJK text by character. Each batch follows document order, with its start times spread over the smaller of animationStagger and the recent interval between batches. When new content arrives, any still-waiting text from the previous batch starts immediately; running and completed animations are left alone. Waiting time does not accumulate across batches. Set animationStagger to 0 to make every new unit in a batch start together.

Detailed configuration