UNPKG

@mindev/min-cli/README.md

Version:

3.34 kBMarkdownView Raw

1# Min Cli
2
3> 令小程序组件的开发和使用变得愉悦
4
5## 介绍
6
7Min资源汇总：[awesome-min](https://github.com/cds803/awesome-min)
8
9Min 是一款微信小程序组件化解决方案，通过预编译的手段让开发者可以选择自己喜欢的开发风格去开发小程序和组件库。而Min与其他组件化框架最大的区别在于是开发真正意义上的小程序组件，通过增强特性能让开发小程序项目变得更加优雅，高效。
10
11同时Min也是一款成长中的小程序组件化方案，大量吸收借鉴了一些优化前端工具以及框架的设计理念和思想。如果Min有不足地方，或者你有更好的想法，欢迎提交ISSUE或者PR。
12
13## 特性
14
15- 提供丰富的[UI组件库](https://github.com/meili/minui)，组件重用方便二次开发
16- [单文件](https://meili.github.io/min/docs/features/single-file-mode.html)开发模式，类Vue开发风格
17- 支持[自定义组件](https://meili.github.io/min/docs/min-cli/wxc-project/index.html)开发
18- 支持[加载海量NPM包](https://meili.github.io/min/docs/features/npm.html)
19- 支持[ES2015+特性、Promise](https://meili.github.io/min/docs/features/babel.html)，使用async/await能够有效避免回调地狱
20- 支持多种[编译器](https://meili.github.io/min/docs/features/style.html)，Less/PostCss、Babel
21- 完善[小程序](https://meili.github.io/min/docs/min-cli/app-project/index.html)和[组件库](https://meili.github.io/min/docs/min-cli/wxc-project/index.html)开发流程，快速建立私有的小程序组件库
22- 支持[全局模板](https://meili.github.io/min/docs/advance/global-layout.html)、[可配置化](https://meili.github.io/min/docs/advance/global-setting.html)，减少维护成本和差异化
23
24## 最佳实践
25
26[MinUI](https://github.com/meili/minui)，是基于 Min 产出的一套 UI 组件库，同时也是蘑菇街小程序在应用的 UI 组件库。通过下面的小程序二维码，可以在手机中体验 MinUI（微信基础库版本 1.6.3 以上支持）：
27
28![](http://s3.mogucdn.com/mlcdn/c45406/171103_5l89d0ih87eh9e715065310ekgdea_220x220.png)
29
30## 环境安装
31
32``` bash
33$ npm install -g @mindev/min-cli
34```
35
36## 组件开发
37
38- **初始化项目**
39
40``` bash
41$ min init
42```
43
44- **新建组件**
45
46``` bash
47$ min new *name
48```
49
50- **开发实时编译**
51
52``` bash
53$ min dev
54```
55
56- **发布组件**
57
58``` bash
59$ min publish
60```
61
62## 组件应用
63
64- **安装组件**
65
66在小程序项目中安装一个组件，这里用 [MinUI](https://github.com/meili/minui) 的 loading 组件举例：
67
68``` bash
69$ min install @minui/wxc-loading
70```
71
72- **更新组件**
73
74``` bash
75$ min update @minui/wxc-loading
76```
77
78## Min 使用交流群
79
80请添加群助手 wUf18018252882 好友或者扫码加好友，并与群助手对话发送验证码 `10088` 按照指引进群。
81
82![微信群](https://s10.mogucdn.com/mlcdn/c45406/180108_888g0d26e23h9j8fc9e3bd7j3e85h_430x430.jpg_220x330.jpg)
83
84## Links
85
86[Documentation](https://meili.github.io/min)
87
88[Changelog](https://meili.github.io/min/docs/changelog/index.html)
89
90[Contributing](https://github.com/meili/min-cli/blob/master/CONTRIBUTING.md)
91
92[License MIT](https://github.com/meili/min-cli/blob/master/LICENSE)
93
94## 开源协议
95
96本项目基于 [MIT](http://opensource.org/licenses/MIT) License，请自由的享受、参与开源。

1	`# Min Cli`
2
3	`> 令小程序组件的开发和使用变得愉悦`
4
5	`## 介绍`
6
7	`Min资源汇总：[awesome-min](https://github.com/cds803/awesome-min)`
8
9	`Min 是一款微信小程序组件化解决方案，通过预编译的手段让开发者可以选择自己喜欢的开发风格去开发小程序和组件库。而Min与其他组件化框架最大的区别在于是开发真正意义上的小程序组件，通过增强特性能让开发小程序项目变得更加优雅，高效。`
10
11	`同时Min也是一款成长中的小程序组件化方案，大量吸收借鉴了一些优化前端工具以及框架的设计理念和思想。如果Min有不足地方，或者你有更好的想法，欢迎提交ISSUE或者PR。`
12
13	`## 特性`
14
15	`- 提供丰富的[UI组件库](https://github.com/meili/minui)，组件重用方便二次开发`
16	`- [单文件](https://meili.github.io/min/docs/features/single-file-mode.html)开发模式，类Vue开发风格`
17	`- 支持[自定义组件](https://meili.github.io/min/docs/min-cli/wxc-project/index.html)开发`
18	`- 支持[加载海量NPM包](https://meili.github.io/min/docs/features/npm.html)`
19	`- 支持[ES2015+特性、Promise](https://meili.github.io/min/docs/features/babel.html)，使用async/await能够有效避免回调地狱`
20	`- 支持多种[编译器](https://meili.github.io/min/docs/features/style.html)，Less/PostCss、Babel`
21	`- 完善[小程序](https://meili.github.io/min/docs/min-cli/app-project/index.html)和[组件库](https://meili.github.io/min/docs/min-cli/wxc-project/index.html)开发流程，快速建立私有的小程序组件库`
22	`- 支持[全局模板](https://meili.github.io/min/docs/advance/global-layout.html)、[可配置化](https://meili.github.io/min/docs/advance/global-setting.html)，减少维护成本和差异化`
23
24	`## 最佳实践`
25
26	`[MinUI](https://github.com/meili/minui)，是基于 Min 产出的一套 UI 组件库，同时也是蘑菇街小程序在应用的 UI 组件库。通过下面的小程序二维码，可以在手机中体验 MinUI（微信基础库版本 1.6.3 以上支持）：`
27
28	`![](http://s3.mogucdn.com/mlcdn/c45406/171103_5l89d0ih87eh9e715065310ekgdea_220x220.png)`
29
30	`## 环境安装`
31
32	``` bash
33	`$ npm install -g @mindev/min-cli`
34	```
35
36	`## 组件开发`
37
38	`- 初始化项目`
39
40	``` bash
41	`$ min init`
42	```
43
44	`- 新建组件`
45
46	``` bash
47	`$ min new *name`
48	```
49
50	`- 开发实时编译`
51
52	``` bash
53	`$ min dev`
54	```
55
56	`- 发布组件`
57
58	``` bash
59	`$ min publish`
60	```
61
62	`## 组件应用`
63
64	`- 安装组件`
65
66	`在小程序项目中安装一个组件，这里用 [MinUI](https://github.com/meili/minui) 的 loading 组件举例：`
67
68	``` bash
69	`$ min install @minui/wxc-loading`
70	```
71
72	`- 更新组件`
73
74	``` bash
75	`$ min update @minui/wxc-loading`
76	```
77
78	`## Min 使用交流群`
79
80	请添加群助手 wUf18018252882 好友或者扫码加好友，并与群助手对话发送验证码 `10088` 按照指引进群。
81
82	`![微信群](https://s10.mogucdn.com/mlcdn/c45406/180108_888g0d26e23h9j8fc9e3bd7j3e85h_430x430.jpg_220x330.jpg)`
83
84	`## Links`
85
86	`[Documentation](https://meili.github.io/min)`
87
88	`[Changelog](https://meili.github.io/min/docs/changelog/index.html)`
89
90	`[Contributing](https://github.com/meili/min-cli/blob/master/CONTRIBUTING.md)`
91
92	`[License MIT](https://github.com/meili/min-cli/blob/master/LICENSE)`
93
94	`## 开源协议`
95
96	`本项目基于 [MIT](http://opensource.org/licenses/MIT) License，请自由的享受、参与开源。`