Skip to content

Introduction

Vue Markdown Design is an out-of-the-box Markdown rendering component for Vue 3, built on markdown-it.

Key Features

🚀 Core - Real-time Markdown rendering, table of contents generation, and full-text search

📦 Builtins - Includes commonly used Markdown features such as emoji, permalinks, and syntax highlighting

🎨 Theming - Replaceable Markdown themes and component styles configurable via CSS variables

🔌 Plugins - Compatible with markdown-it plugins for flexible extensibility

📱 Responsive - Optimized for both desktop and mobile with responsive layouts

🧩 Modular - Import core features on demand and compose components for flexible layouts

🛡️ Security - HTML sanitization is enabled by default to mitigate XSS and other attacks

📋 Typings - Written in TypeScript with complete type definitions

What is markdown-it?

markdown-it is a JavaScript parser that converts Markdown into HTML. It is fast, secure, and highly extensible, with a rich plugin ecosystem. It is widely used in blogs, documentation sites, and editor previews.

Community

Feedback

Changelog

License

Released under the MIT license.