Skip to content

介绍

Vue Markdown Design 是一个基于 markdown-it 的 Vue 3 开箱即用 Markdown 渲染组件。

主要特性

🚀 核心功能 - 提供 Markdown 实时渲染,目录生成和全文搜索功能

📦 开箱即用 - 集成 Markdown 常用功能,包括 Emoji 表情、标题永久链接、代码高亮等

🎨 主题定制 - 可替换的 Markdown 主题,可通过 CSS 变量配置的组件样式

🔌 生态兼容 - 兼容 markdown-it 插件,支持丰富的功能扩展

📱 跨端适配 - 适配 PC 端和移动端,支持响应式布局

🧩 模块设计 - 核心功能支持按需引入,自由组合满足多样化布局需求

🛡️ 安全防护 - 默认启用 HTML 内容安全过滤,有效防范 XSS 等网络攻击

📋 类型提示 - 使用 TypeScript 开发,提供完整的类型定义

什么是 markdown-it?

markdown-it 是一个专门用于将 Markdown 文本解析并渲染成 HTML 的 JavaScript 解析器。它具备性能优异、安全性高、扩展性强等特点,并且拥有丰富的插件生态。广泛应用于博客、文档网站和编辑器预览等场景。

社区

意见反馈

更新日志

开源协议

本项目基于 MIT 协议。