ARTICLE DETAIL

资讯详情

深耕网站视觉设计与运营推广的一线实战洞察。

markdown-it-vue 完整指南:三步在 Vue 项目中接入 Markdown 渲染组件

markdown-it-vue 完整指南:三步在 Vue 项目中接入 Markdown 渲染组件 markdown-it-vue 完整指南三步在 Vue 项目中接入 Markdown 渲染组件【免费下载链接】markdown-it-vueThe vue lib for markdown-it.项目地址: https://gitcode.com/gh_mirrors/ma/markdown-it-vue想在 Vue 项目里渲染 Markdown你要么一个个拼装 markdown-it 的解析插件要么只能接受朴素的文字展示。markdown-it-vue就是一个开箱即用的 Vue Markdown 渲染组件它内置 markdown-it 解析引擎和大批插件一条npm install装完GFM 语法、emoji、代码高亮、Mermaid/ECharts 图表、图片预览等能力直接可用。 适用场景markdown-it-vue 适合谁写技术文档 / 博客 / 知识库的 Vue 应用内容以 Markdown 存储页面上想要所见即所得的渲染效果而不是自己手写 HTML。不想手动拼插件的人markdown-it-emoji、footnote、task-lists、katex 等十几个插件它已整合好你只管传content字符串。文档里需要重内容目录锚点GFM TOC、数学公式、图表、带预览的图片这类需求单靠原生 markdown-it 要配半天它开箱就有。✨ 核心能力一览你能得到哪些功能功能类别具体能力说明语法渲染官方 CommonMark GFM 风格表格、删除线、任务列表、脚注等目录GFM TOC用[toc]自动生成目录并带锚点链接图片尺寸控制 图片查看器img语法控制大小点击可放大预览图表Mermaid、ECharts、flowchart.jsECharts 仅用 simple 版以控制体积数学KaTeX / Latex / AsciiMath支持行内与块级公式代码highlight.js 高亮内置 Python、Go、Java、SQL 等常用语言其他emoji、上下标、info/warning/error 提示块提示块适合做告警、说明类文案 快速上手三步完成 markdown-it-vue 安装第 1 步 · 检查环境确认本机已安装 Node.js 和 npm或 yarn项目是一个 Vue 2 应用当前版本基于vue ^2.6.12构建。第 2 步 · 安装依赖npm install markdown-it-vue第 3 步 · 引入组件注册组件后把 Markdown 原文绑到:content上即可。注意必须同时引入它的 CSS否则渲染样式会全丢template markdown-it-vue classmd-body :contentcontent / /template script import MarkdownItVue from markdown-it-vue import markdown-it-vue/dist/markdown-it-vue.css export default { components: { MarkdownItVue }, data() { return { content: # Hello markdown-it-vue } } } /script⚙️ 进阶技巧常用配置项速查1. 用:options调整解析与链接行为所有 markdown-it 及各插件的选项都通过options属性透传比如开启链接自动识别、让外链在新窗口打开options: { markdownIt: { linkify: true }, linkAttributes: { attrs: { target: _blank, rel: noopener } } }2. 控制图片对齐与预览image: { hAlign: center, viewer: true }hAlign可选left/center/rightviewer关闭后图片点击不再弹出预览。3. 挂载你自己的 markdown-it 插件组件暴露了use方法任何标准 markdown-it 插件都能追加this.$refs.myMd.use(MyCustomPlugin) 包体积敏感试试markdown-it-vue-light精简版它移除了 mermaid 及其带来的 lodash 依赖引入路径换成markdown-it-vue/dist/markdown-it-vue-light.umd.min.js和对应 CSS功能其余不变。 常见问题FAQQ支持 Vue 3 吗目前构建基于 Vue 2vue ^2.6.12Vue 3 项目请等待官方适配版本或自行评估迁移成本。Q打包体积太大怎么办ECharts 只打包了 simple 版如果不用 Mermaid 图表直接换用markdown-it-vue-light能砍掉 mermaid 和 lodash 这块大头。Q代码高亮里没有我要的语言内置 highlight.js 只打包了常用语言Python、Go、Java、SQL、TypeScript 等。可通过options.markdownIt.highlight传入自定义高亮函数注入自己需要的语言。写在最后一个组件把 Markdown 解析、样式、图表、公式一次配齐——这就是 markdown-it-vue 的价值。想深入了解可看 中文 README或直接打开 示例项目 边跑边读源码。【免费下载链接】markdown-it-vueThe vue lib for markdown-it.项目地址: https://gitcode.com/gh_mirrors/ma/markdown-it-vue创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考
返回列表