markdown-it-vue:Vue Markdown 渲染组件,从纯文本到图表公式完整指南
【免费下载链接】markdown-it-vueThe vue lib for markdown-it.项目地址: https://gitcode.com/gh_mirrors/ma/markdown-it-vue
markdown-it-vue 是一个 Vue 2 的 Markdown 渲染组件:它把 markdown-it 引擎封装成单个 Vue 组件,表情、数学公式、Mermaid 流程图、ECharts 数据图一次搞定。如果你不想在 Vue 项目里自己拼装十几个 markdown-it 插件,这就是现成方案。
快速上手——5 分钟跑通第一个 Markdown 渲染
先克隆仓库,把官方示例跑起来,就能看到全部渲染效果:
git clone https://gitcode.com/gh_mirrors/ma/markdown-it-vue cd markdown-it-vue && yarn install && yarn dev在自己的项目里接入分四步:装依赖、引入组件和样式、传入内容、完成。
import MarkdownItVue from 'markdown-it-vue' import 'markdown-it-vue/dist/markdown-it-vue.css' export default { components: { MarkdownItVue }, data: () => ({ content: '# 你的 Markdown 内容' }) }核心能力——它到底能渲染什么?
从上面这张真实渲染截图就能看出库里的家底:
- 📊 Mermaid 流程图——直接在 Markdown 里画架构图、时序图,不用切画图工具
- 📈 ECharts 数据图——正文里放一段配置,变成饼图、折线图,且默认用 simple 版控制体积
- 🧮 KaTeX 与 AsciiMath 公式——分式、求和、上下标都能正常排版
- 😀 Emoji 与 FontAwesome 图标——行文里随手撒表情和小图标
- 🔖 GitHub 风格 TOC——长文自动生成可点击的目录锚点
- 🗂️ Info / Warning / Error 提示块——把正文里的重要信息标出来
- ✅ 任务列表、定义列表、下划线、删除线——常见 GFM 扩展语法
- 🖼️ 图片尺寸控制与预览——
图指定宽高,点击放大 - 💻 40+ 语言代码高亮——从 Python、Go 到 Rust、Kotlin 都有
配置与定制——让渲染行为服从你的规则
一个options属性覆盖全部开关,能配的东西按功能分五组:
- 链接行为:
linkAttributes设置外链target、rel,默认新标签页打开 - 公式容错:
katex.throwOnError和errorColor决定公式写错时是报错还是标红显示 - 图表主题:
mermaid.theme切换 Mermaid 配色 - 图片展示:
image.hAlign控制对齐,image.viewer开关点击预览 - 解析引擎:
markdownIt透传linkify等 markdown-it 标准选项
options: { markdownIt: { linkify: true }, linkAttributes: { attrs: { target: '_blank', rel: 'noopener' } }, katex: { throwOnError: false, errorColor: '#cc0000' } }还不够的话,用use方法追加自己的 markdown-it 插件即可,不用 fork 改源码。
谁适合用它?——典型落地场景
- 技术博客 / 知识库→ 公式和图表混排时页面样式跑偏 → 一个组件统一渲染,样式不漂移
- 在线课程平台→ 数学课需要 LaTeX,前端搭不起来 → Markdown 里直接写公式,KaTeX 出图
- 内部 API 文档→ 目录和提示块要手写,维护成本高 → TOC、info/warning 块开箱即用
- 内容管理前端→ 每加一个渲染需求就要改代码 → options 一行配置切换渲染策略
选择它的 4 个理由
- 开箱即用的渲染矩阵:emoji、上下标、脚注、TOC、高亮等 15+ 个 markdown-it 插件已经组装好并锁好版本,不用自己盯兼容性
- 源码不改动:所有行为开关都走
options,内置插件实现就在src/下,例如src/markdown-it-plugin-mermaid.js,想深挖随时可读 - 包体按需控制:
-light构建移除 mermaid 依赖,ECharts 也默认走 simple 构建 - 可再扩展:一次
use调用挂上自己的插件即可生效,不碰库内部代码
去翻翻仓库里example/下的完整示例,配置基本可以直接抄。如果你的 Markdown 项目还需要渲染图表、公式这类重活,这个组件值得试一次。
【免费下载链接】markdown-it-vueThe vue lib for markdown-it.项目地址: https://gitcode.com/gh_mirrors/ma/markdown-it-vue
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考