Skip to content

Commit 72ccfd6

Browse files
committed
docs: polish up
1 parent 2e21f74 commit 72ccfd6

File tree

6 files changed

+17
-8
lines changed

6 files changed

+17
-8
lines changed

docs/.vitepress/config.ts

+7-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,13 @@ export default defineConfig({
1414
pattern: 'https://github.com/fi3ework/vite-plugin-checker/edit/main/docs/:path',
1515
text: 'Edit this page on GitHub',
1616
},
17-
socialLinks: [{ icon: 'github', link: 'https://github.com/fi3ework/vite-plugin-checker' }],
17+
socialLinks: [
18+
{ icon: 'github', link: 'https://github.com/fi3ework/vite-plugin-checker' },
19+
{
20+
icon: 'npm',
21+
link: 'https://www.npmjs.com/package/vite-plugin-checker',
22+
},
23+
],
1824
footer: {
1925
message: 'Released under the MIT License.',
2026
copyright: 'Copyright fi3ework',

docs/checkers/vue-tsc.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
# vue-tsc (Vue Language Tools)
22

3-
You can use vue-tsc checker for your Vue3 project. If you're still using Vue2, choose [VLS](/checkers/vls) checker.
3+
You can use vue-tsc checker for your Vue 3 project. If you're still using Vue2, choose [VLS](/checkers/vls) checker.
44

55
## Installation
66

7+
::: info
8+
Since `0.7.0`, `vue-tsc` requires at least >= `2.0.0`, with typescript >= `5.0.0`. If you can't upgrade to the latest version, please use `0.6.x` or below version.
9+
:::
10+
711
1. Make sure [vue-tsc](https://www.npmjs.com/package/vue-tsc) & [typescript](https://www.npmjs.com/package/typescript) are installed as a peer dependency of your Vite project.
812

913
```bash
1014
pnpm add vue-tsc@latest typescript -D
1115
```
1216

13-
::: tip
14-
The `vue-tsc` version **must** be >= `2.0.0`.
15-
:::
16-
1717
2. Add `vueTsc` field to plugin config.
1818

1919
```js

docs/index.md

+3
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ hero:
88
name: vite-plugin-checker
99
text: Add Checks to Your Vite Project
1010
tagline: Vite plugin that provide checks of TypeScript, ESLint, vue-tsc, and more.
11+
image:
12+
src: /logo.png
13+
alt: vite-plugin-checker
1114
actions:
1215
- theme: brand
1316
text: Get Started

docs/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
"dependencies": {
66
"@vueuse/core": "^8.9.4",
77
"body-scroll-lock": "4.0.0-beta.0",
8-
"vitepress": "^1.0.0-alpha.73",
8+
"vitepress": "^1.2.3",
99
"vue": "^3.2.37"
1010
}
1111
}

docs/public/logo.png

34.9 KB
Loading

pnpm-lock.yaml

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)