Skip to content

Commit e40e405

Browse files
committed
chore(docs): Update readme
1 parent eec1e0e commit e40e405

File tree

2 files changed

+26
-25
lines changed

2 files changed

+26
-25
lines changed

README.md

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -66,29 +66,29 @@
6666

6767
### UI Frameworks
6868

69-
- [UnoCSS](https://github.com/antfu/unocss) - The instant on-demand atomic CSS engine.
70-
- [`@unocss/preset-rem-to-px`](https://github.com/unocss/unocss/tree/main/packages/preset-rem-to-px) - Converts rem to px for all utilities.
71-
- [`eslint-plugin-unocss`](https://github.com/devunt/eslint-plugin-unocss) - ESLint plugin for UnoCSS.
72-
- [Vant](https://github.com/youzan/vant) - Vue UI library for mobile web apps.
73-
- [`vant-touch-emulator`](https://github.com/youzan/vant/tree/main/packages/vant-touch-emulator) - Simulate mobile touch events on the desktop.
74-
- [`vant-use`](https://github.com/youzan/vant/tree/main/packages/vant-use) - Built-in composition APIs of Vant.
69+
- [UnoCSS](https://github.com/antfu/unocss) - The instant on-demand atomic CSS engine
70+
- [`@unocss/preset-rem-to-px`](https://github.com/unocss/unocss/tree/main/packages/preset-rem-to-px) - Converts rem to px for all utilities
71+
- [`eslint-plugin-unocss`](https://github.com/devunt/eslint-plugin-unocss) - ESLint plugin for UnoCSS
72+
- [Vant](https://github.com/youzan/vant) - Vue UI library for mobile web apps
73+
- [`vant-touch-emulator`](https://github.com/youzan/vant/tree/main/packages/vant-touch-emulator) - Simulate mobile touch events on the desktop
74+
- [`vant-use`](https://github.com/youzan/vant/tree/main/packages/vant-use) - Built-in composition APIs of Vant
7575

7676
### Plugins
7777

7878
- [Vue Router](https://github.com/vuejs/router)
79-
- [`vue-router-better-scroller`](https://github.com/antfu/vue-router-better-scroller) - Enhanced scroll behavior for Vue Router.
80-
- [Pinia](https://pinia.vuejs.org) - Intuitive, type safe, light and flexible Store for Vue using the composition api.
81-
- [`pinia-plugin-persistedstate`](https://github.com/prazdevs/pinia-plugin-persistedstate) - Configurable persistence and rehydration of Pinia stores.
79+
- [`vue-router-better-scroller`](https://github.com/antfu/vue-router-better-scroller) - Enhanced scroll behavior for Vue Router
80+
- [Pinia](https://pinia.vuejs.org) - Intuitive, type safe, light and flexible Store for Vue using the composition api
81+
- [`pinia-plugin-persistedstate`](https://github.com/prazdevs/pinia-plugin-persistedstate) - Configurable persistence and rehydration of Pinia stores
8282
- [unplugin-vue-components](https://github.com/antfu/unplugin-vue-components) - components auto import
8383
- [unplugin-auto-import](https://github.com/antfu/unplugin-auto-import) - Directly use Vue Composition API and others without importing
84-
- [vite-plugin-vconsole](https://github.com/vadxq/vite-plugin-vconsole) - A lightweight, extendable front-end developer tool for mobile web page.
85-
- [vite-plugin-mock-dev-server](https://github.com/pengzhanbo/vite-plugin-mock-dev-server) - Vite Plugin for API mock dev server.
86-
- [postcss-mobile-forever](https://github.com/wswmsword/postcss-mobile-forever) - To adapt different displays by one mobile viewport.
84+
- [vite-plugin-vconsole](https://github.com/vadxq/vite-plugin-vconsole) - A lightweight, extendable front-end developer tool for mobile web page
85+
- [vite-plugin-mock-dev-server](https://github.com/pengzhanbo/vite-plugin-mock-dev-server) - Vite Plugin for API mock dev server
86+
- [postcss-mobile-forever](https://github.com/wswmsword/postcss-mobile-forever) - To adapt different displays by one mobile viewport
8787

8888
### Coding Style
8989

9090
- Use Composition API with [`<script setup>` SFC syntax](https://github.com/vuejs/rfcs/pull/227)
91-
- [ESLint](https://eslint.org/) with [@antfu/eslint-config](https://github.com/antfu/eslint-config), single quotes, no semi.
91+
- [ESLint](https://eslint.org/) with [@antfu/eslint-config](https://github.com/antfu/eslint-config), single quotes, no semi
9292

9393
### Dev tools
9494

@@ -102,13 +102,13 @@
102102
- [Iconify IntelliSense](https://marketplace.visualstudio.com/items?itemName=antfu.iconify) - Icon inline display and autocomplete
103103
- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
104104

105-
## Try it now!
105+
## Try it now
106106

107-
> Vue3-Vant-Mobile requires Node >= 16.16.0
107+
> Vue3-Vant-Mobile requires Node 18+
108108
109109
### GitHub Template
110110

111-
[Create a repo from this template on GitHub](https://github.com/CharleeWa/vue3-vant-mobile/generate).
111+
[Create a repo from this template on GitHub](https://github.com/CharleeWa/vue3-vant-mobile/generate)
112112

113113
### Clone to local
114114

@@ -136,7 +136,7 @@ And, enjoy :)
136136

137137
### Development
138138

139-
Just run and visit http://localhost:3000
139+
Just run and visit <http://localhost:3000>
140140

141141
```bash
142142
pnpm dev
@@ -149,6 +149,7 @@ To build the App, run
149149
```bash
150150
pnpm build
151151
```
152+
152153
And you will see the generated file in `dist` that ready to be served.
153154

154155
### Deploy on Netlify

README.zh-CN.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,8 @@
6767
### UI 框架
6868

6969
- [UnoCSS](https://github.com/antfu/unocss) - 高性能且极具灵活性的即时原子化 CSS 引擎
70-
- [`@unocss/preset-rem-to-px`](https://github.com/unocss/unocss/tree/main/packages/preset-rem-to-px) - 将所有实用程序的 rem 转换为 px
71-
- [`eslint-plugin-unocss`](https://github.com/devunt/eslint-plugin-unocss) - Unocss 的 ESLint 插件
70+
- [`@unocss/preset-rem-to-px`](https://github.com/unocss/unocss/tree/main/packages/preset-rem-to-px) - 将所有实用程序的 rem 转换为 px
71+
- [`eslint-plugin-unocss`](https://github.com/devunt/eslint-plugin-unocss) - Unocss 的 ESLint 插件
7272
- [Vant](https://github.com/youzan/vant) - 移动端 Vue 组件库
7373
- [`vant-touch-emulator`](https://github.com/youzan/vant/tree/main/packages/vant-touch-emulator) - 在桌面端上模拟移动端 touch 事件
7474
- [`vant-use`](https://github.com/youzan/vant/tree/main/packages/vant-use) - Vant 内置的组合式 API
@@ -88,7 +88,7 @@
8888
### 编码风格
8989

9090
- 使用 Composition API 地 [`<script setup>` SFC 语法](https://github.com/vuejs/rfcs/pull/227)
91-
- [ESLint](https://eslint.org/) 配置为 [@antfu/eslint-config](https://github.com/antfu/eslint-config), 单引号, 无分号.
91+
- [ESLint](https://eslint.org/) 配置为 [@antfu/eslint-config](https://github.com/antfu/eslint-config), 单引号, 无分号
9292

9393
### 开发工具
9494

@@ -102,13 +102,13 @@
102102
- [Iconify IntelliSense](https://marketplace.visualstudio.com/items?itemName=antfu.iconify) - 图标内联显示和自动补全
103103
- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
104104

105-
## 现在可以试试!
105+
## 现在可以试试
106106

107-
> Vue3-Vant-Mobile 需要 Node 版本 >= 16.16.0
107+
> Vue3-Vant-Mobile 需要 Node 版本 18+
108108
109109
### GitHub 模板
110110

111-
[使用这个模板创建仓库](https://github.com/CharleeWa/vue3-vant-mobile/generate).
111+
[使用这个模板创建仓库](https://github.com/CharleeWa/vue3-vant-mobile/generate)
112112

113113
### 克隆到本地
114114

@@ -136,7 +136,7 @@ pnpm i # 如果你没装过 pnpm, 可以先运行: npm install -g pnpm
136136

137137
### 开发
138138

139-
只需要执行以下命令就可以在 http://localhost:3000 中看到
139+
只需要执行以下命令就可以在 <http://localhost:3000> 中看到
140140

141141
```bash
142142
pnpm dev
@@ -154,7 +154,7 @@ pnpm build
154154

155155
### 部署到 Netlify
156156

157-
前往 [Netlify](https://app.netlify.com/start) 并选择你的仓库, 一路 `OK` 下去,稍等一下后,你的应用将被创建.
157+
前往 [Netlify](https://app.netlify.com/start) 并选择你的仓库, 一路 `OK` 下去,稍等一下后,你的应用将被创建
158158

159159
## 贡献者
160160

0 commit comments

Comments
 (0)