Skip to content

Commit 95490b8

Browse files
committed
docs: added README.md
1 parent a5c00b3 commit 95490b8

File tree

11 files changed

+100
-2
lines changed

11 files changed

+100
-2
lines changed

PLAN.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
# readme.md
22
# ci
33
# PlAN
4+
# drag
5+
# close bug

README.md

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
<p align="center">
2+
<img src="https://ikun-ui.netlify.app/logo.svg" width="180" height="180"/>
3+
</p>
4+
<h1 align="center">
5+
ikun-svelte-devtools
6+
</h1>
7+
<p align="center">
8+
🍨 A vite plugin that improves the svelte development experience
9+
</p>
10+
11+
12+
## Features
13+
14+
![overview.png](public%2Foverview.png)
15+
16+
### page
17+
18+
In the pages module, you can quickly understand which pages the project contains
19+
20+
![page.png](public%2Fpage.png)
21+
22+
### Routes
23+
In the Routes module, you can quickly understand the routing information of the project
24+
25+
![router.png](public%2Frouter.png)
26+
27+
### Assets
28+
In the Assets module, you can quickly understand the static resources of the project, including pictures, fonts, etc.
29+
30+
![assets.png](public%2Fassets.png)
31+
32+
### Search Packages
33+
In the Search Packages module you can search for dependencies and install or uninstall them
34+
35+
![search-package.png](public%2Fsearch-package.png)
36+
37+
### Inspect
38+
In the Inspect module you can view the compiled code, It comes from `vite-plugin-inspect` support.
39+
40+
![inpect.png](public%2Finpect.png)
41+
42+
### Graph
43+
In the Graph module, you can quickly understand the reference relationship between js and sfc through visualization
44+
45+
![graph.png](public%2Fgraph.png)
46+
47+
### Inspector
48+
In the Inspector module, you can click on an element on the page to open the corresponding source code in the IDE.
49+
It comes from `svelte-kit-inspector` support.
50+
51+
52+
### EyeDropper
53+
EyeDropper module can open a color picker
54+
55+
## Install
56+
57+
```bash
58+
npm i @ikun-svelte-devtools/server -D
59+
```
60+
Or
61+
```bash
62+
yarn add @ikun-svelte-devtools/server -D
63+
```
64+
Or
65+
```bash
66+
pnpm add @ikun-svelte-devtools/server -D
67+
```
68+
69+
## Usage
70+
```ts
71+
// vite.config.ts
72+
import { sveltekit } from '@sveltejs/kit/vite';
73+
import { defineConfig } from 'vite';
74+
import svelteDevtools from '@ikun-svelte-devtools/server';
75+
export default defineConfig({
76+
plugins: [
77+
svelteDevtools({
78+
sveltekit: sveltekit()
79+
}),
80+
],
81+
});
82+
83+
```
84+
## Thanks
85+
86+
- [svelte](https://github.com/sveltejs/svelte)
87+
- [unocss](https://github.com/nuxt/devtools)
88+
- [vite-plugin-vue-devtools](https://github.com/webfansplz/vite-plugin-vue-devtools)

package.json

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
11
{
22
"name": "@ikun-svelte-devtools/core",
3-
"description": "A vite plugin for Svelte Devtools",
3+
"description": "\uD83C\uDF68 A vite plugin that improves the svelte development experience",
44
"type": "module",
55
"version": "0.0.1-beta.12",
66
"keywords": [
77
"vue-devtools",
88
"vite-plugin",
99
"vite-plugin-vue-devtools",
1010
"svelte-devtools",
11-
"svelte-devtools-plus",
1211
"vite-plugin-svelte-devtools",
1312
"dx"
1413
],

packages/server/package.json

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,18 @@
11
{
22
"name": "@ikun-svelte-devtools/server",
3+
"description": "\uD83C\uDF68 A vite plugin that improves the svelte development experience",
34
"type": "module",
45
"version": "0.0.1-beta.12",
56
"main": "./dist/index.js",
67
"types": "dist/index.d.ts",
8+
"keywords": [
9+
"vue-devtools",
10+
"vite-plugin",
11+
"vite-plugin-vue-devtools",
12+
"svelte-devtools",
13+
"vite-plugin-svelte-devtools",
14+
"dx"
15+
],
716
"files": [
817
"dist",
918
"src/app",

public/assets.png

34.8 KB
Loading

public/graph.png

67.9 KB
Loading

public/inpect.png

59.3 KB
Loading

public/overview.png

38.2 KB
Loading

public/page.png

29 KB
Loading

public/router.png

35.6 KB
Loading

0 commit comments

Comments
 (0)