Skip to content

Commit 8495354

Browse files
committed
docs: readme
1 parent dde42b7 commit 8495354

File tree

7 files changed

+30
-19
lines changed

7 files changed

+30
-19
lines changed

README.md

+18-19
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11

22
<p align="center">
3-
<a href="https://github.com/webfansplz/vite-plugin-vue-inspector"><img src="https://github.com/webfansplz/vite-plugin-vue-inspector/blob/main/docs/images/logo.png" alt="vite-plugin-vue-inspector"></a>
3+
<a href="https://github.com/webfansplz/vite-plugin-vue-inspector"><img src="./logo.svg" width="180" alt="vite-plugin-vue-inspector"></a>
44
</p>
55

66
<p align="center">
@@ -10,15 +10,15 @@
1010
</p>
1111

1212
<p align="center">
13-
<a href="https://stackblitz.com/edit/vitejs-vite-te3qgo?file=vite.config.ts&terminal=dev"><img src="https://developer.stackblitz.com/img/open_in_stackblitz.svg" alt=""></a>
13+
<a href="https://stackblitz.com/edit/vitejs-vite-rbr2as?file=src%2FApp.vue"><img src="https://developer.stackblitz.com/img/open_in_stackblitz.svg" alt=""></a>
1414
</p>
1515

1616
## 📖 Introduction
1717

1818
A vite plugin which provides the ability that to jump to the local IDE when you click the element of browser automatically. It supports Vue2 & 3 & SSR.
1919

2020
<p align="center">
21-
<img src="https://github.com/webfansplz/vite-plugin-vue-inspector/blob/main/docs/images/vite-plugin-vue-inspector.gif" alt="vite-plugin-vue-inspector">
21+
<img src="./public/preview.gif" alt="vite-plugin-vue-inspector">
2222
</p>
2323

2424
## 📦 Installation
@@ -41,9 +41,9 @@ npm install vite-plugin-vue-inspector -D
4141
```ts
4242
// for Vue2
4343

44-
import { defineConfig } from "vite"
45-
import { createVuePlugin } from "vite-plugin-vue2"
46-
import Inspector from "vite-plugin-vue-inspector"
44+
import { defineConfig } from 'vite'
45+
import { createVuePlugin } from 'vite-plugin-vue2'
46+
import Inspector from 'vite-plugin-vue-inspector'
4747

4848
export default defineConfig({
4949
plugins: [
@@ -58,9 +58,9 @@ export default defineConfig({
5858
```ts
5959
// for Vue3
6060

61-
import { defineConfig } from "vite"
62-
import Vue from "@vitejs/plugin-vue"
63-
import Inspector from "vite-plugin-vue-inspector"
61+
import { defineConfig } from 'vite'
62+
import Vue from '@vitejs/plugin-vue'
63+
import Inspector from 'vite-plugin-vue-inspector'
6464

6565
export default defineConfig({
6666
plugins: [Vue(), Inspector()],
@@ -72,18 +72,17 @@ export default defineConfig({
7272
// nuxt.config.ts
7373

7474
import { defineNuxtConfig } from 'nuxt'
75-
import Inspector from "vite-plugin-vue-inspector"
75+
import Inspector from 'vite-plugin-vue-inspector'
7676

7777
export default defineNuxtConfig({
7878
vite: {
79-
plugins:[
79+
plugins: [
8080
Inspector({
81-
appendTo: "entry.mjs"
81+
appendTo: 'entry.mjs'
8282
})
8383
]
8484
}
8585
})
86-
8786
```
8887

8988
### Options
@@ -118,13 +117,13 @@ interface VitePluginInspectorOptions {
118117
* Toggle button visibility
119118
* @default 'active'
120119
*/
121-
toggleButtonVisibility?: "always" | "active" | "never"
120+
toggleButtonVisibility?: 'always' | 'active' | 'never'
122121

123122
/**
124123
* Toggle button display position
125124
* @default top-right
126125
*/
127-
toggleButtonPos?: "top-right" | "top-left" | "bottom-right" | "bottom-left"
126+
toggleButtonPos?: 'top-right' | 'top-left' | 'bottom-right' | 'bottom-left'
128127

129128
/**
130129
* append an import to the module id ending with `appendTo` instead of adding a script into body
@@ -138,9 +137,9 @@ interface VitePluginInspectorOptions {
138137

139138
### Example
140139

141-
- [Vue2](https://github.com/webfansplz/vite-plugin-vue-inspector/tree/main/example/vue2)
142-
- [Vue3](https://github.com/webfansplz/vite-plugin-vue-inspector/tree/main/example/vue3)
143-
- [Nuxt3](https://github.com/webfansplz/vite-plugin-vue-inspector/tree/main/example/nuxt)
140+
- [Vue2](https://github.com/webfansplz/vite-plugin-vue-inspector/tree/main/packages/playground/vue2)
141+
- [Vue3](https://github.com/webfansplz/vite-plugin-vue-inspector/tree/main/packages/playground/vue3)
142+
- [Nuxt3](https://github.com/webfansplz/vite-plugin-vue-inspector/tree/main/packages/playground/nuxt)
144143

145144
## 🔌 Configuration IDE / Editor
146145

@@ -152,7 +151,7 @@ For example, if you want it always open VSCode when inspection clicked, set `exp
152151
### VSCode
153152

154153
- install VSCode command line tools, [see the official docs](https://code.visualstudio.com/docs/setup/mac#_launching-from-the-command-line)
155-
![install-vscode-cli](https://github.com/webfansplz/vite-plugin-vue-inspector/blob/main/docs/images/install-vscode-cli.png)
154+
![install-vscode-cli](./public/install-vscode-cli.png)
156155

157156
- set env to shell, like `.bashrc` or `.zshrc`
158157

docs/images/logo.png

-115 KB
Binary file not shown.
-3.26 MB
Binary file not shown.

logo.png

-115 KB
Binary file not shown.

logo.svg

+12
Loading
File renamed without changes.

public/preview.gif

3.57 MB
Loading

0 commit comments

Comments
 (0)