Skip to content

Commit

Permalink
docs: polish up
Browse files Browse the repository at this point in the history
  • Loading branch information
fi3ework committed Jun 30, 2024
1 parent 2e21f74 commit 72ccfd6
Show file tree
Hide file tree
Showing 6 changed files with 17 additions and 8 deletions.
8 changes: 7 additions & 1 deletion docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,13 @@ export default defineConfig({
pattern: 'https://github.com/fi3ework/vite-plugin-checker/edit/main/docs/:path',
text: 'Edit this page on GitHub',
},
socialLinks: [{ icon: 'github', link: 'https://github.com/fi3ework/vite-plugin-checker' }],
socialLinks: [
{ icon: 'github', link: 'https://github.com/fi3ework/vite-plugin-checker' },
{
icon: 'npm',
link: 'https://www.npmjs.com/package/vite-plugin-checker',
},
],
footer: {
message: 'Released under the MIT License.',
copyright: 'Copyright fi3ework',
Expand Down
10 changes: 5 additions & 5 deletions docs/checkers/vue-tsc.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
# vue-tsc (Vue Language Tools)

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

## Installation

::: info
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.
:::

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.

```bash
pnpm add vue-tsc@latest typescript -D
```

::: tip
The `vue-tsc` version **must** be >= `2.0.0`.
:::

2. Add `vueTsc` field to plugin config.

```js
Expand Down
3 changes: 3 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ hero:
name: vite-plugin-checker
text: Add Checks to Your Vite Project
tagline: Vite plugin that provide checks of TypeScript, ESLint, vue-tsc, and more.
image:
src: /logo.png
alt: vite-plugin-checker
actions:
- theme: brand
text: Get Started
Expand Down
2 changes: 1 addition & 1 deletion docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"dependencies": {
"@vueuse/core": "^8.9.4",
"body-scroll-lock": "4.0.0-beta.0",
"vitepress": "^1.0.0-alpha.73",
"vitepress": "^1.2.3",
"vue": "^3.2.37"
}
}
Binary file added docs/public/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 72ccfd6

Please sign in to comment.