Skip to content

Commit 4b8f212

Browse files
committed
chore: update readme
1 parent eaa8f0e commit 4b8f212

File tree

3 files changed

+7
-3
lines changed

3 files changed

+7
-3
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@
1111
<a href="./README.zh-CN.md">简体中文</a>
1212
</p>
1313

14+
> Version 2.x fails to build when used in vitepress, please use version 1.x for now (PR welcome)
15+
1416
A Vite plugin made for previewing and editing Vue components in Markdown and, of course, exporting a **VuePreview** component to be used directly in Vue applications.
1517

1618
## Demo
@@ -22,7 +24,7 @@ A Vite plugin made for previewing and editing Vue components in Markdown and, of
2224
## Install
2325

2426
```bash
25-
pnpm add vite-plugin-vue-preview
27+
pnpm add vite-plugin-vue-preview@1
2628
```
2729

2830
## Features

README.zh-CN.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@
1111
<a href="./README.md">English</a>
1212
</p>
1313

14+
> 2.x版本在vitepress中使用时构建失败,请暂时使用1.x版本(欢迎pr)
15+
1416
一个为在 Markdown 中预览和编辑Vue组件而生的Vite插件,当然,也导出了一个 **VuePreview** 组件可以直接在 Vue 应用中使用
1517

1618
## 演示
@@ -22,7 +24,7 @@
2224
## 安装
2325

2426
```bash
25-
pnpm add vite-plugin-vue-preview
27+
pnpm add vite-plugin-vue-preview@1
2628
```
2729

2830
## 特征

test/vue/src/DemoSfc.vue

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<script lang="ts" setup>
22
import '../../../dist/style.css'
3-
import { VuePreview } from '../../../dist'
3+
import VuePreview from '../../../dist/sfc'
44
</script>
55

66
<template>

0 commit comments

Comments
 (0)