Skip to content

Commit 6b216ad

Browse files
committed
docs: a simple README, subject to further refinement
1 parent 5a11298 commit 6b216ad

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

template/config/base/README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Vue 3 + Vite
2+
3+
This template should help get you started developing with Vue 3 in Vite.
4+
5+
## Recommended IDE Setup
6+
7+
[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.volar) (and disable Vetur).
8+
9+
## Type Support for `.vue` Imports in TS
10+
11+
Since TypeScript cannot handle type information for `.vue` imports, they are shimmed to be a generic Vue component type by default. In most cases this is fine if you don't really care about component prop types outside of templates.
12+
13+
However, if you wish to get actual prop types in `.vue` imports (for example to get props validation when using manual `h(...)` calls), you can run `Volar: Switch TS Plugin on/off` from VSCode command palette.
14+
15+
### Customize configuration
16+
17+
See [Vite Configuration Reference](https://vitejs.dev/config/).

0 commit comments

Comments
 (0)