Parser & API

markstream-vue builds on top of markdown-it-ts and exposes a streaming-friendly parser.

For the full parser API reference, see:

• /guide/parser-api
• stream-markdown-parser README (parser-only package): https://www.npmjs.com/package/stream-markdown-parser

Highlights:

• getMarkdown() — create and configure a markdown-it-ts instance
• parseMarkdownToStructure() — turn a Markdown string into parsed nodes used by MarkdownRender
• setDefaultMathOptions() — global math options
• Streaming inline HTML mid-states (html_inline) — suppress partial tags and auto-close unclosed inline HTML for flicker-free streaming.

If you only need the parser (no Vue), install and import from stream-markdown-parser. Otherwise, markstream-vue re-exports the same helpers for convenience.

Try this quickly — parse a small string and render the result in your app:

import { parseMarkdownToStructure } from 'markstream-vue'

const nodes = parseMarkdownToStructure('# Hello\n\nThis is a test')
// Render nodes with <MarkdownRender :nodes="nodes" />