Skip to content

MarkdownEditor

Markdown editor component based on Vditor.

Basic Usage

json
{
  "com": "MarkdownEditor",
  "model": "content"
}

Props

PropertyTypeDefaultDescription
value / v-modelstring-Markdown content
heightstring | number'400px'Editor height
placeholderstring'Enter content...'Placeholder text
modestring'ir'Edit mode: sv (split), ir (instant render), wysiwyg
readonlybooleanfalseWhether readonly

Examples

Basic Usage

json
{
  "data": {
    "content": "# Title\n\nThis is **Markdown** content."
  },
  "com": "MarkdownEditor",
  "model": "content"
}

Set Height

json
{
  "com": "MarkdownEditor",
  "model": "content",
  "props": { "height": "600px" }
}

Split Mode

json
{
  "com": "MarkdownEditor",
  "model": "content",
  "props": { "mode": "sv" }
}

Readonly Preview

json
{
  "com": "MarkdownEditor",
  "props": {
    "value": "{{ content }}",
    "readonly": true
  }
}

Features

  • Live preview
  • Syntax highlighting
  • Image upload
  • Table editing
  • Code blocks
  • Math formulas
  • Flowcharts
  • Outline navigation
  • Export functionality

Released under the MIT License