Vue script setup 怎么在 Markdown 中直接渲染自定义组件

风浩大大_7695

风浩大大_7695

2026-10-21

422人浏览

原创

vitepress 的 markdown 文件天然支持 vue 语法,包括 ,每个 .md 文件被当作 vue 单文件组件处理,无需额外配置即可内联定义和使用自定义组件。

vue script setup 怎么在 markdown 中直接渲染自定义组件

VitePress 的 Markdown 文件天然支持 Vue 语法,包括 <script setup></script> —— 因为每个 .md 文件在构建时会被当作一个 Vue 单文件组件(SFC)处理。你不需要额外配置,就能在 Markdown 中直接定义并使用带 script setup 的自定义组件。

在 .md 文件中内联定义组件

直接在 Markdown 文件顶部或任意位置用 <script setup></script> 声明组件逻辑和响应式数据,再用 <template></template> 渲染结构。VitePress 会自动识别并编译:

  • 组件必须写在 Markdown 内容之外(推荐放在文件开头或结尾),不能嵌套在段落、列表等 Markdown 解析上下文中
  • <script setup></script> 和 <template></template> 必须成对出现,且不能跨多个代码块
  • 支持 defineProps、defineEmits、组合式 API 及顶层 import

示例:

<script setup>
import { ref } from 'vue'
const count = ref(0)
const increment = () => count.value++
</script><p><template><button>点击 {{ count }} 次</button>
</template></p><hr><p>上面就是一个可交互的按钮,它就定义在当前 Markdown 文件里。
</p>

在 Markdown 中使用已注册的全局/局部组件

如果你已在项目中全局注册了组件(如通过 app.component()),或在当前 .md 文件中通过 <script setup></script> 显式 import 并使用,就能直接在 Markdown 正文中调用:

Video To Markdown
Video To Markdown

分析任意YouTube、Facebook或Instagram视频链接,结合AI视觉分析提取的画面,生成全面的Markdown参考文档。

下载
  • 确保组件名符合 PascalCase(如 MyCard),并在 Markdown 中用 kebab-case 使用(<my-card></my-card>)
  • 支持 props 传递、事件绑定、插槽内容(包括默认插槽和具名插槽)
  • 注意:Markdown 解析器默认会把 <my-card>...</my-card> 当作 HTML 标签处理,所以需开启 VitePress 的 markdown.html 配置(默认已启用)

例如,在 docs/guide.md 中:

import MyCard from '../components/MyCard.vue'
<p><mycard title="Vue + Markdown">
这段文字会作为默认插槽内容传入。
</mycard></p>

渲染含 Vue 组件的 Markdown 内容(非 VitePress 场景)

若你不是用 VitePress,而是用 markdown-it 或 marked 在普通 Vue 组件中渲染 Markdown 字符串,那原生不支持 <script setup></script>。此时要让自定义组件生效,需走「运行时挂载」方案:

  • 先用 markdown-it 解析 Markdown,开启 html: true,使自定义标签(如 <my-button></my-button>)保留在输出 HTML 中
  • 在渲染后的 DOM 节点中,查找这些自定义标签,用 createApp() 手动挂载对应 Vue 组件到该节点
  • 适合轻量场景;复杂交互建议改用 VitePress 或封装专用 Markdown 渲染器(如基于 remark/rehype)

注意事项与避坑点

常见问题多源于作用域和解析顺序:

  • 不要在 Markdown 列表项或段落内部写 <script setup></script> —— 它不会被识别,会被当作普通文本或解析错误
  • 组件中使用的响应式数据无法通过 Markdown 前置元数据(frontmatter)直接注入,需在 <script setup></script> 内主动读取 useData()(VitePress)或 defineProps
  • 样式隔离需手动处理:<style scoped></style> 在 .md 文件中有效,但仅作用于该组件自身,不影响 Markdown 解析出的普通 HTML 元素
  • SSR 场景下,确保组件无浏览器专属 API(如 window),否则构建报错

前端入门到VUE实战笔记:立即使用
在学习笔记中,你将探索 前端 的入门与实战技巧!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2583

5

前端如何实现即时通讯
前端如何实现即时通讯

实现即时通讯的方法有WebSocket、Long Polling、Server-Sent Events、WebRTC等等。详细介绍:1、WebSocket,它可以在客户端和服务器之间建立持久连接,实现实时的双向通信,前端可以使用 WebSocket API来创建WebSocket连接,并通过发送和接收消息来实现即时通讯;2、Long Polling,是一种模拟实时通信的技术等等。

2023.10.09

5563

6

前端和后端的区别
前端和后端的区别

前端关注的是用户界面的设计和交互,而后端则注重数据处理和逻辑控制。想了解更多前端后端的相关内容,可以阅读本专题下面的文章。

2024.03.19

6590

13

php和前端的关联介绍
php和前端的关联介绍

php既可以作为前端语言,也可以作为后端语言。想了解更多php和前端的相关内容,可以阅读本专题下面的文章。

2024.03.22

6238

10

前端外包工作内容有哪些
前端外包工作内容有哪些

前端外包工作内容包括:1. 网站和应用程序开发;2. 用户界面和交互设计;3. 用户体验优化;4. 设计和视觉开发;5. 跨浏览器兼容性;6. 性能优化;7. 维护和更新;8. 项目管理和沟通。想了解更多前端的相关内容,可以阅读本专题下面的文章。

2024.05.22

883

5

vue2.0和3.0区别
vue2.0和3.0区别

vue2.0和3.0区别:vue2的响应式原理是利⽤“Object.defineProperty()”对数据进⾏劫持结合发布订阅模式的⽅式来实现,vue3中使⽤了es6的proxy API对数据代理,实现对数据的监控。本专题为大家提供vue2.0和3.0区别的相关的文章、下载、课程内容,供大家免费下载体验。

2023.07.17

1694

5

vue3的生命周期有哪些
vue3的生命周期有哪些

vue3的生命周期:1、beforecreate;2、created;3、beforemount;4、mounted;5、beforeupdate;6、updated;7、beforedestroy;8、destroyed;9、activated;10、deactivated等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.02.23

12182

5

Vue3组合式API与组件开发实战
Vue3组合式API与组件开发实战

本专题讲解 Vue 3 组合式 API 的核心概念与应用技巧,深入分析响应式系统、生命周期管理、组件设计与复用策略。通过完整项目案例,指导前端开发者实现高性能、结构清晰的 Vue 应用,提升开发效率与代码可维护性。

2026.02.10

316

23

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Vue 教程
Vue 教程

共42课时 | 17.2万人学习

国外Web开发全栈课程全集
国外Web开发全栈课程全集

共12课时 | 1.4万人学习

Vue.js 微实战--十天技能课堂
Vue.js 微实战--十天技能课堂

共18课时 | 1.7万人学习