Skip to content

Commit 27243c1

Browse files
docs: ✏️ 添加脚手架与模板的介绍
1 parent 645e022 commit 27243c1

6 files changed

Lines changed: 174 additions & 1 deletion

File tree

docs/.vitepress/locales/en-US.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,10 @@ export default defineConfig({
2424
text: 'Quick Start',
2525
link: '/en-US/guide/quick-use',
2626
},
27+
{
28+
text: 'CLI & Templates',
29+
link: '/en-US/guide/cli-templates',
30+
},
2731
{
2832
text: 'Custom Theme',
2933
link: '/en-US/guide/custom-theme',
@@ -98,6 +102,10 @@ export default defineConfig({
98102
text: 'Quick Start',
99103
link: '/en-US/guide/quick-use',
100104
},
105+
{
106+
text: 'CLI & Templates',
107+
link: '/en-US/guide/cli-templates',
108+
},
101109
{
102110
text: 'Custom Theme',
103111
link: '/en-US/guide/custom-theme',

docs/.vitepress/locales/zh-CN.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,10 @@ export default defineConfig({
2424
text: '快速上手',
2525
link: '/guide/quick-use',
2626
},
27+
{
28+
text: '脚手架与模板',
29+
link: '/guide/cli-templates',
30+
},
2731
{
2832
text: '定制主题',
2933
link: '/guide/custom-theme',
@@ -98,6 +102,10 @@ export default defineConfig({
98102
text: '快速上手',
99103
link: '/guide/quick-use',
100104
},
105+
{
106+
text: '脚手架与模板',
107+
link: '/guide/cli-templates',
108+
},
101109
{
102110
text: '定制主题',
103111
link: '/guide/custom-theme',

docs/en-US/guide/cli-templates.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# CLI & Templates
2+
3+
Through this section, you can learn how to use the [create-uni](https://github.com/uni-helper/create-uni) CLI to quickly create a `uni-app` project integrated with `Wot UI`, as well as many quick-start projects that have already integrated `Wot UI`.
4+
5+
## CLI
6+
7+
We recommend using [create-uni](https://github.com/uni-helper/create-uni) to create projects, which supports one-click creation of basic projects integrated with Wot UI. Use the following command:
8+
9+
```bash
10+
pnpm create uni <your-project-name> --ts -m pinia -u wot -e
11+
```
12+
13+
This will complete the following tasks:
14+
15+
- Create a TypeScript project
16+
- Integrate Pinia state management
17+
- Automatically configure WotUI component library
18+
- Add ESLint support
19+
20+
For more information, please refer to [create-uni](https://github.com/uni-helper/create-uni).
21+
22+
## Templates
23+
24+
There are many excellent templates that have chosen Wot UI as their base component library. We've selected 3 templates to introduce here, and you can compare and choose for yourself.
25+
26+
### wot-demo
27+
28+
🍀 [wot-demo](https://github.com/Moonofweisheng/wot-demo) is a `uni-app` quick-start project based on [vitesse-uni-app](https://github.com/uni-helper/vitesse-uni-app) with deep integration of the `Wot UI` component library. It's maintained by the `Wot UI` team, saying goodbye to `HBuilderX` and embracing modern frontend development toolchains. If you're a loyal user of `Wot UI`, this template is perfect for you.
29+
30+
You can also combine it with the CLI section [create-uni](https://github.com/uni-helper/create-uni) to create a project. Open the terminal and use the following command:
31+
32+
```bash
33+
pnpm create uni <project-name> -t wot-demo
34+
```
35+
36+
Open the project folder in VS Code:
37+
38+
```bash
39+
code <project-name>
40+
```
41+
42+
Install dependencies:
43+
44+
```bash
45+
pnpm install
46+
```
47+
48+
Run the project:
49+
50+
```bash
51+
pnpm dev
52+
```
53+
54+
### vitesse-uni-app
55+
56+
[vitesse-uni-app](https://github.com/uni-helper/vitesse-uni-app) is a cross-platform quick-start template powered by `Vite & uni-app`, backed by the `Uni Helper` team, saying goodbye to `HBuilderX` and embracing modern frontend development. Although it doesn't have deep integration with the Wot UI component library, it's an excellent clean template worth recommending.
57+
58+
### unibest
59+
60+
[unibest](https://github.com/unibest-tech/unibest) uses the latest frontend technology stack and doesn't need to rely on `HBuilderX`. It runs through command line, with `VSCode` as the recommended editor (or `webstorm`). It has built-in extensive basic functionality and provides numerous auxiliary features, giving you the `best` experience when writing `uniapp`, with optional `Wot UI` support.
61+
62+
### More Templates
63+
64+
Of course, there are more templates for you to choose from. You can compare and select a template you like from the following list.
65+
66+
If you're developing a `uni-app` template integrated with `Wot UI`, you can send an email to `1780903673@qq.com` to contact me, and I'll add your template to this list as soon as possible.
67+
68+
| Template | Stars | Description |
69+
|----------|-------|-------------|
70+
| [wot-demo](https://github.com/Moonofweisheng/wot-demo) | ![stars](https://img.shields.io/github/stars/Moonofweisheng/wot-demo) | 🍀 A uni-app quick-start project based on vitesse-uni-app with deep integration of Wot UI component library, maintained by the `Wot UI` team, saying goodbye to `HBuilderX` and embracing modern frontend development toolchains. |
71+
| [vitesse-uni-app](https://github.com/uni-helper/vitesse-uni-app) | ![stars](https://img.shields.io/github/stars/uni-helper/vitesse-uni-app) | A cross-platform quick-start template powered by Vite & uni-app, backed by the Uni Helper team, saying goodbye to HBuilderX and embracing modern frontend development. |
72+
| [unibest](https://github.com/unibest-tech/unibest) | ![stars](https://img.shields.io/github/stars/unibest-tech/unibest) | Uses the latest frontend technology stack, doesn't need to rely on `HBuilderX`, runs through command line, with built-in extensive basic functionality and auxiliary features, giving you the `best` experience when writing `uniapp`. |
73+
| [vite-uniapp-template](https://github.com/viarotel-org/vite-uniapp-template) | ![stars](https://img.shields.io/github/stars/viarotel-org/vite-uniapp-template) | A practical-first uni-app starter template. |
74+
| [uni-plus](https://github.com/DaMaiCoding/uni-plus) | ![stars](https://img.shields.io/github/stars/DaMaiCoding/uni-plus) | A "super super super" useful uniapp development template. |
75+
| [uniez-template](https://github.com/zhe-qi/uniez-template) | ![stars](https://img.shields.io/github/stars/zhe-qi/uniez-template) | A uniapp template that prioritizes "functionality" and "development experience". |
76+
| [snail-uni](https://github.com/hu-snail/snail-uni) | ![stars](https://img.shields.io/github/stars/hu-snail/snail-uni) | A UniApp framework template built specifically for developers. |

docs/en-US/guide/quick-use.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -196,4 +196,5 @@ You can also use [create-uni](https://github.com/uni-helper/create-uni) to quick
196196

197197
```bash
198198
pnpm create uni@latest -t wot-demo <your project name>
199-
```
199+
```
200+
For more scaffolding and templates, see [CLI & Templates](./cli-templates.html).

docs/guide/cli-templates.md

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
# 脚手架与模板
2+
3+
通过本章节你可以了解如何使用 [create-uni](https://github.com/uni-helper/create-uni) 脚手架快速创建集成了 `Wot UI``uni-app` 项目,以及很多已经集成了 `Wot UI``uni-app` 快速起手项目。
4+
5+
## 脚手架
6+
7+
我们推荐使用 [create-uni](https://github.com/uni-helper/create-uni) 创建项目,它支持一键创建集成 Wot UI 的基础项目。使用以下命令:
8+
9+
```bash
10+
pnpm create uni <你的项目名称> --ts -m pinia -u wot -e
11+
```
12+
13+
将会完成以下工作:
14+
15+
- 创建一个 TypeScript 项目
16+
- 集成 Pinia 状态管理
17+
- 自动配置 WotUI 组件库
18+
- 添加 ESLint 支持
19+
20+
更多信息请参见 [create-uni](https://github.com/uni-helper/create-uni)
21+
22+
## 模板
23+
24+
有非常多的优秀模板选择了 Wot UI 作为基础组件库,我们选取其中的3个模板模板来介绍一番,大家可以自行对比、选择。
25+
26+
### wot-demo
27+
28+
🍀 [wot-demo](https://github.com/Moonofweisheng/wot-demo) 是一个基于 [vitesse-uni-app](https://github.com/uni-helper/vitesse-uni-app) 深度整合 `Wot UI` 组件库的 `uni-app` 快速起手项目。它由 `Wot UI` 团队维护,告别 `HBuilderX` ,拥抱现代前端开发工具链。如果你是 `Wot UI` 的忠实用户,那么这个模板非常适合你。
29+
30+
也可以结合脚手架章节 [create-uni](https://github.com/uni-helper/create-uni) 来创建项目,打开终端,然后使用以下命令:
31+
32+
```bash
33+
pnpm create uni <project-name> -t wot-demo
34+
```
35+
36+
在 VS Code 中打开项目文件夹:
37+
38+
```bash
39+
code <project-name>
40+
```
41+
42+
安装依赖:
43+
44+
```bash
45+
pnpm install
46+
```
47+
48+
运行项目:
49+
50+
```bash
51+
pnpm dev
52+
```
53+
54+
### vitesse-uni-app
55+
56+
[vitesse-uni-app](https://github.com/uni-helper/vitesse-uni-app)`Vite & uni-app` 驱动的跨端快速启动模板,背靠 `Uni Helper` 团队,告别 `HBuilderX` ,拥抱现代前端开发。虽然没有深度整合 Wot UI 组件库,但是它是一个非常优秀的纯净模板,值得推荐。
57+
58+
59+
### unibest
60+
61+
[unibest](https://github.com/unibest-tech/unibest) 使用了最新的前端技术栈,无需依靠 `HBuilderX`,通过命令行方式运行,编辑器推荐 `VSCode`,可选 `webstorm`)。内置大量基础功能,提供大量辅助功能,让你编写 `uniapp` 拥有 `best` 体验,可选择使用`Wot UI`
62+
63+
64+
### 更多模板
65+
66+
当然,还有更多的模板供你选择,你可以从以下列表中比较并选择一个你喜欢的模板来使用。
67+
68+
如果你正在开发整合 `Wot UI``uni-app` 模板,那么可以发送邮件到 `1780903673@qq.com` 联系我,我会在第一时间将你的模板添加到这个列表中。
69+
70+
| 模板 | Stars | 描述 |
71+
|------|-------|-------------|
72+
| [wot-demo](https://github.com/Moonofweisheng/wot-demo) | ![stars](https://img.shields.io/github/stars/Moonofweisheng/wot-demo) | 🍀 基于 vitesse-uni-app 深度整合 Wot UI 组件库的 uni-app 快速起手项目,它由 `Wot UI` 团队维护,告别 `HBuilderX` ,拥抱现代前端开发工具链。 |
73+
| [vitesse-uni-app](https://github.com/uni-helper/vitesse-uni-app) | ![stars](https://img.shields.io/github/stars/uni-helper/vitesse-uni-app) | 由 Vite & uni-app 驱动的跨端快速启动模板,背靠 Uni Helper 团队,告别 HBuilderX ,拥抱现代前端开发。 |
74+
| [unibest](https://github.com/unibest-tech/unibest) | ![stars](https://img.shields.io/github/stars/unibest-tech/unibest) | 使用了最新的前端技术栈,无需依靠 `HBuilderX`,通过命令行方式运行,内置大量基础功能,提供大量辅助功能,让你编写 `uniapp` 拥有 `best` 体验。 |
75+
| [vite-uniapp-template](https://github.com/viarotel-org/vite-uniapp-template) | ![stars](https://img.shields.io/github/stars/viarotel-org/vite-uniapp-template) | 以实用为先的 uni-app 起手模板。 |
76+
| [uni-plus](https://github.com/DaMaiCoding/uni-plus) | ![stars](https://img.shields.io/github/stars/DaMaiCoding/uni-plus) | 一个 “超超超” 好用的 uniapp 开发模板。 |
77+
| [uniez-template](https://github.com/zhe-qi/uniez-template) | ![stars](https://img.shields.io/github/stars/zhe-qi/uniez-template) | 一个“功能”和“开发体验”优先的 uniapp 模板。 |
78+
| [snail-uni](https://github.com/hu-snail/snail-uni) | ![stars](https://img.shields.io/github/stars/hu-snail/snail-uni) | 专为开发者打造的 UniApp 框架模板。 |

docs/guide/quick-use.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -197,3 +197,5 @@ cli 项目使用 `uni_modules` 安装无需配置,对 `Volar` 的支持自动
197197
```bash
198198
pnpm create uni@latest -t wot-demo <你的项目名称>
199199
```
200+
201+
更多脚手架与模板,请参见[脚手架与模板](./​​cli-and-templates.html)

0 commit comments

Comments
 (0)