Guide
Choose Your Framework
This documentation covers multiple framework versions. Select your preferred framework:
Vue 3 (markstream-vue) ⭐ Recommended
The latest and most feature-rich version.
| Page | Description |
|---|---|
| Installation | Setup and peer dependencies |
| Quick Start | Get started in minutes |
| Features | Streaming, Mermaid, Monaco, and more |
| Components API | Full component reference |
| Usage & API | Advanced usage patterns |
Vue 2 (markstream-vue2)
For Vue 2.6+ (with Composition API) and Vue 2.7+ projects.
| Page | Description |
|---|---|
| Installation | Vue 2 specific setup |
| Quick Start | Vue 2 examples |
| Components & API | Vue 2 component reference |
React (markstream-react)
For React 18+ projects with hooks and TypeScript.
| Page | Description |
|---|---|
| Installation | React specific setup |
| Quick Start | React examples |
| Components & API | React component reference |
Nuxt
For Nuxt 3 SSR applications.
- Nuxt SSR Guide - Server-side rendering configuration
Quick Try
Render a short guide page directly in your app:
vue
<script setup>
import MarkdownRender from 'markstream-vue'
const md = '# Welcome to the guide\n\nThis is a short demo.'
</script>
<template>
<MarkdownRender :content="md" />
</template>Use the left sidebar navigation to explore all topics in detail.