Skip to content

Commit 17b12be

Browse files
CharleeWaCharleeWa
committed
docs: 📝 add chinese description document
1 parent 5d54e05 commit 17b12be

File tree

2 files changed

+138
-0
lines changed

2 files changed

+138
-0
lines changed

‎README-zh_CN.md

Lines changed: 136 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,136 @@
1+
<p align="center">
2+
<img alt="logo" src="https://opens-1308879050.cos.ap-beijing.myqcloud.com/vvm/logo.png" width="120" height="120" style="margin-bottom: 10px;">
3+
</p>
4+
5+
<h1 align="center">Vue3-Vant-Mobile</h1>
6+
7+
<p align="center">一个集成 Vue3、Vite4、Vant4、Pinia2、Vitest、TypeScript 构建的移动端模板</p>
8+
9+
<p align="center">
10+
<img src="https://img.shields.io/github/license/CharleeWa/vue3-vant-mobile" alt="license" />
11+
<img src="https://img.shields.io/github/package-json/v/CharleeWa/vue3-vant-mobile" alt="version" />
12+
<img src="https://img.shields.io/github/repo-size/CharleeWa/vue3-vant-mobile" alt="repo-size" />
13+
<img src="https://img.shields.io/github/languages/top/CharleeWa/vue3-vant-mobile" alt="languages" />
14+
<img src="https://img.shields.io/github/issues-closed/CharleeWa/vue3-vant-mobile" alt="issues" />
15+
</p>
16+
17+
[English](./README.md) | 简体中文
18+
19+
## 介绍
20+
21+
🔥🔥🔥 这是一个基于 `Vue3`, `Vite4`, `Vant4`, `Pinia2`, `Vitest`, `TypeScript` 构建的移动端模板。 🚀🚀🚀 它集成了`Plop`用于生成各种类型的代码块，同时还提供了 `Dark Mode`（暗黑模式）配置以及 `Mock` 数据等其他方便的扩展功能。💖💖💖 简而言之，它简洁、简单、易用，可供参考，能够帮助您节省一周的开发时间，希望您会喜欢。
22+
23+
## 成就
24+
25+
🎉🎉🎉 被添加到 [Awesome Vite.Js](https://github.com/vitejs/awesome-vite#vue-3)
26+
27+
## 特性
28+
29+
- 🌓 支持暗黑模式
30+
- 💪 使用TypeScript编写
31+
- 🚀 Vue3 生态开箱即用
32+
- 🤖 自动导入组件
33+
- 📄 使用plop轻松创建文件
34+
- 📦 使用pnpm包管理器
35+
- 💾 支持Mock服务器
36+
- 🌈 支持Git hooks（lint和commit）
37+
- 💖 移动端UI组件（Vant4）
38+
- 🍍 Pinia，Vue的状态管理库
39+
40+
## 安装与使用
41+
42+
- 获取项目代码
43+
44+
```bash
45+
git clone https://github.com/CharleeWa/vue3-vant-mobile.git
46+
```
47+
48+
- 安装依赖
49+
50+
```bash
51+
cd vue3-vant-mobile
52+
53+
# with pnpm
54+
pnpm install
55+
56+
```
57+
58+
- 运行
59+
60+
```bash
61+
pnpm dev
62+
```
63+
64+
- 打包构建
65+
66+
```bash
67+
pnpm build
68+
```
69+
70+
## 浏览器支持
71+
72+
支持现代浏览器
73+
74+
| [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt=" Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>IE | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt=" Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Edge | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Firefox | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Chrome | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Safari |
75+
| :-: | :-: | :-: | :-: | :-: |
76+
| not support | last 2 versions | last 2 versions | last 2 versions | last 2 versions |
77+
78+
## 贡献者
79+
80+
<table>
81+
<tr>
82+
<td align="center">
83+
<a href="https://github.com/CharleeWa">
84+
<img src="https://avatars.githubusercontent.com/u/22477554?s=96&v=4" width="90;" alt="CharleeWa"/>
85+
<br />
86+
<sub><b>Charlie Wang</b></sub>
87+
</a>
88+
</td>
89+
<td align="center">
90+
<a href="https://github.com/weiq">
91+
<img src="https://avatars.githubusercontent.com/u/1697158?v=4" width="90;" alt="weiq"/>
92+
<br />
93+
<sub><b>魏小雨</b></sub>
94+
</a>
95+
</td>
96+
<td align="center">
97+
<a href="https://github.com/AlphaYoung111">
98+
<img src="https://avatars.githubusercontent.com/u/54132313?v=4" width="90;" alt="AlphaYoung"/>
99+
<br />
100+
<sub><b>AlphaYoung</b></sub>
101+
</a>
102+
</td>
103+
<td align="center">
104+
<a href="https://github.com/Leezon">
105+
<img src="https://avatars.githubusercontent.com/u/38120280?v=4" width="90;" alt="Leezon"/>
106+
<br />
107+
<sub><b>Leezon</b></sub>
108+
</a>
109+
</td>
110+
<td align="center">
111+
<a href="https://github.com/leo4developer">
112+
<img src="https://avatars.githubusercontent.com/u/15160478?v=4" width="90;" alt="liuNing"/>
113+
<br />
114+
<sub><b>liuNing</b></sub>
115+
</a>
116+
</td>
117+
<td align="center">
118+
<a href="https://github.com/wswmsword">
119+
<img src="https://avatars.githubusercontent.com/u/26893092?v=4" width="90;" alt="wswmsword"/>
120+
<br />
121+
<sub><b>wswmsword</b></sub>
122+
</a>
123+
</td>
124+
<td align="center">
125+
<a href="https://github.com/Kysen777">
126+
<img src="https://avatars.githubusercontent.com/u/63892082?v=4" width="90;" alt="Kysen"/>
127+
<br />
128+
<sub><b>Kysen</b></sub>
129+
</a>
130+
</td>
131+
</tr>
132+
</table>
133+
134+
## 许可证
135+
136+
♥️ [MIT](https://en.wikipedia.org/wiki/MIT_License)

‎README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@
1414
<img src="https://img.shields.io/github/issues-closed/CharleeWa/vue3-vant-mobile" alt="issues" />
1515
</p>
1616

17+
English | [简体中文](./README-zh_CN.md)
18+
1719
## Introduction
1820

1921
🔥🔥🔥 Vue3 Vant Mobile based on `Vue3`, `Vite4`, `Vant4`, `Pinia2`, `Vitest`, `TypeScript`; 🚀🚀🚀 Integrate `Plop` to generate any type of code block, integrate `Dark Mode` (Dark) configuration, integrate `Mock` data, and other handy extensions. 💖💖💖 In short, clean, simple, easy to use, reference, can save you a week of development time, hope you like it.

0 commit comments

Comments
 (0)