Skip to content

Commit

Permalink
feat: 更新文档
Browse files Browse the repository at this point in the history
Signed-off-by: Tenny <joel.shu@qq.com>
  • Loading branch information
Tenny committed Feb 1, 2024
1 parent e6cbf0b commit 9340ddf
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 17 deletions.
20 changes: 6 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,10 @@
# Vue 3 + TypeScript + Vite
# neatui-vue

This template should help get you started developing with Vue 3 and TypeScript in Vite. The template uses Vue 3 `<script setup>` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.
`Neat UI` 是一个基于 `Vue3` 的轻量级的 `UI` 组件库,提供基础的 `UI` 组件,方便开发。

## Recommended IDE Setup
## 文档

- [VS Code](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).
[中文文档](https://neatui.github.io/neatui-vue/)

## 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.

If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a [Take Over Mode](https://github.com/johnsoncodehk/volar/discussions/471#discussioncomment-1361669) that is more performant. You can enable it by the following steps:

1. Disable the built-in TypeScript Extension
1. Run `Extensions: Show Built-in Extensions` from VSCode's command palette
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.
## LICENSE
neatui-vue is open source software licensed as [MulanPSL2](https://github.com/DvShu/neatui-vue/blob/main/LICENSE).
7 changes: 4 additions & 3 deletions src/App.vue
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,11 @@ import GiteeIcon from './app_components/GiteeIcon.vue';
import GithubIcon from './app_components/GithubIcon.vue';
import asids from './asides';
import type { AsideItem } from './asides';
import { debounce } from 'ph-utils/web';
import { debounce, query } from 'ph-utils/web';
import { isBlank } from 'ph-utils';
let pageName = location.pathname.substring(1);
console.log(location.search);
let pageName = query()['page'];
if (isBlank(pageName)) {
pageName = 'usage';
}
Expand Down Expand Up @@ -55,7 +56,7 @@ function handleSearchFocus(dir: 'in' | 'out') {
function handleToggleDoc(name: string) {
if (name !== pageName) {
location.href = '/' + name;
location.href = '/?page=' + name;
}
}
Expand Down

0 comments on commit 9340ddf

Please sign in to comment.