aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Corentin Thomasset <corentin.thomasset74@gmail.com> 2023-03-24 08:42:28 +0100
committerGravatar Corentin Thomasset <corentin.thomasset74@gmail.com> 2023-03-24 08:42:28 +0100
commitdab8d633902b41ad439da1b03872022d4b5e346a (patch)
treeedf1bb4da66f126490d04a9b4a03d31e14e792a4
parent96aaa35ea23c0110382f82e783d7a8a8ac040fa6 (diff)
downloadit-tools-dab8d633902b41ad439da1b03872022d4b5e346a.tar.gz
it-tools-dab8d633902b41ad439da1b03872022d4b5e346a.tar.zst
it-tools-dab8d633902b41ad439da1b03872022d4b5e346a.zip
refactor(readme): better headings levels
-rw-r--r--README.md10
1 files changed, 3 insertions, 7 deletions
diff --git a/README.md b/README.md
index 2806375..98784fd 100644
--- a/README.md
+++ b/README.md
@@ -19,11 +19,11 @@ docker run -d -p 8080:80 --name it-tools -it corentinth/it-tools
## Contribute
-## Recommended IDE Setup
+### Recommended IDE Setup
[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin).
-## Type Support for `.vue` Imports in TS
+### Type Support for `.vue` Imports in TS
TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) to make the TypeScript language service aware of `.vue` types.
@@ -34,11 +34,7 @@ If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has a
2. Find `TypeScript and JavaScript Language Features`, right click and select `Disable (Workspace)`
2. Reload the VSCode window by running `Developer: Reload Window` from the command palette.
-## Customize configuration
-
-See [Vite Configuration Reference](https://vitejs.dev/config/).
-
-## Project Setup
+### Project Setup
```sh
pnpm install