Install & Compatibility
Where this runs
tested against v? · npm install
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
muslnode 18–226 runs
build_error
glibcnode 18–226 runs
build_error
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
MarkstreamRenderer
✓ import { MarkstreamRenderer } from 'markstream-vue'
✗ import MarkstreamRenderer from 'markstream-vue'
Named export — default export is not available.
default
✓ import MarkstreamRenderer from 'markstream-vue'
✗ const MarkstreamRenderer = require('markstream-vue')
When using CJS, use require('markstream-vue').default; import default from ESM.
type MarkstreamOptions
✓ import type { MarkstreamOptions } from 'markstream-vue'
✗ import { MarkstreamOptions } from 'markstream-vue'
Options is a TypeScript type — use `import type` for type-only imports.
MarkstreamRendererProps
✓ import type { MarkstreamRendererProps } from 'markstream-vue'
✗ import { MarkstreamRendererProps } from 'markstream-vue'
Props is a TypeScript type — use `import type`.
Basic usage of MarkstreamRenderer component with streaming, KaTeX math, and Mermaid diagram support.
<template>
<MarkstreamRenderer
:content="markdownContent"
:stream-options="{ mode: 'incremental' }"
:highlight="true"
:katex="true"
:mermaid="true"
/>
</template>
<script setup lang="ts">
import { ref } from 'vue'
import { MarkstreamRenderer } from 'markstream-vue'
import 'markstream-vue/dist/style.css'
const markdownContent = ref('# Hello Markstream\n\nThis is **streaming** markdown with $E=mc^2$ math.')
</script>
Errors
Common errors & fixes
Failed to resolve component: MarkstreamRenderer
Component not registered or imported incorrectly (missing named import).
fixUse `import { MarkstreamRenderer } from 'markstream-vue'` and register locally or globally. [Vue warn]: Failed to resolve prop: stream-options
Using 'streamOptions' instead of kebab-case 'stream-options' in template.
fixUse `:stream-options` (kebab-case) or bind via `v-bind:streamOptions`.
Module not found: Can't resolve 'katex'
KaTeX peer dependency not installed but :katex="true" is set.
fixRun `npm install katex` or set `:katex="false"` if not needed.
TypeError: markstream_vue_1.default is not a function
Using CommonJS require() without accessing .default.
fixUse `const { MarkstreamRenderer } = require('markstream-vue')`. Upgrade
Version history
0.0.13-beta.7latest on npm
Audit
Dependencies
vuerequiredPeer dependency — requires Vue >=3.0 for component rendering
stream-markdownrequiredPeer dependency — core stream parsing logic
katexoptionalPeer dependency — renders LaTeX math expressions
mermaidoptionalPeer dependency — renders diagrams in Markdown
vue-i18noptionalPeer dependency — required for internationalization support
@antv/infographicoptionalPeer dependency — alternative diagram rendering
@terrastruct/d2optionalPeer dependency — alternative diagram rendering
stream-monacooptionalPeer dependency — streaming Monaco editor integration