当前位置: 首页 > news >正文

vitepress | 文档:展示与说明只写一次,使用vitepress-deme-preview插件

展示和说明:一个显示“展示”部分,一个显示“代码”部分 —— 只写一次,采用 vitepress-demo-preview 插件(vitepress-demo-preview 的文档)

安装 npm install @vitepress-demo-preview/component @vitepress-demo-preview/plugin --save-dev

配置

主题配置导入,在  .vitepress/theme/index.ts 文件中

import DefaultTheme from 'vitepress/theme'
import { AntDesignContainer, ElementPlusContainer, NaiveUIContainer } from '@vitepress-demo-preview/component'
import '@vitepress-demo-preview/component/dist/style.css'export default {...DefaultTheme,enhanceApp({ app }: { app: App }) {app.component('demo-preview', AntDesignContainer)}
}

 添加 markdown 插件,在 config.ts 中配置

import { defineConfig } from 'vitepress'
import { containerPreview, componentPreview } from '@vitepress-demo-preview/plugin'export default defineConfig({markdown: {config(md) {md.use(containerPreview)md.use(componentPreview)}}
})

 两种展示的方法:

① 组件 component 的写法

<!-- Tip: Support for closed tags --><preview path="./xxx/xx.vue"></preview><preview path="./xxx/xx.vue" title="title"></preview><preview path="./xxx/xx.vue" title="title" description="component description content"></preview>

注: 写在一行,不要换行,会不生效! 

例子:

 ② 容器 container 的写法:

:::previewdemo-preview=./xxx/xx.vue::::::preview titledemo-preview=./xxx/xx.vue::::::preview title || component description contentdemo-preview=./xxx/xx.vue:::

相关文章:

  • redis的AOF恢复数据
  • 【编译原理】语法分析方法总结
  • 医疗AI项目文档编写核心要素硬核解析:从技术落地到合规实践
  • ​《Nacos终极指南:集群配置+负载均衡+健康检查+配置中心全解析,让微服务稳如老狗!》​
  • upload-labs通关笔记-第21关 文件上传之数组绕过
  • 数据结构---二叉树
  • 使用Spring Boot和Spring Security结合JWT实现安全的RESTful API
  • kafka之操作示例
  • Web安全技术体系
  • 09 接口自动化-用例管理框架pytest之allure报告定制以及数据驱动
  • 【概率论基本概念01】点估计
  • github好玩的工具
  • GitHub 趋势日报 (2025年05月23日)
  • 39-居住证管理系统(小程序)
  • 2025年第八届广西大学生程序设计大赛(热身赛)题解
  • jmeter中文乱码问题
  • x64_ubuntu22.04.5安装:cuda driver + cuda toolkit
  • JavaSE核心知识点03高级特性03-03(IO流)
  • 人工智能在医疗影像诊断上的最新成果:更精准地识别疾病
  • Oracle表索引变为不可用状态了怎么办
  • 多语言网站难做么/重庆网站
  • 陇南网站设计/seo长尾快速排名
  • 用html5做的网站过程/西安做网站的公司
  • asp做网站优点/海南百度推广运营中心
  • 前端网站建设和维护/seo推广有哪些公司
  • 淄企业网站建设公司/素材网