mirror of
https://github.com/youzan/vant.git
synced 2025-10-14 23:20:41 +00:00
[Doc] add introduction page (#452)
This commit is contained in:
49
README.md
49
README.md
@@ -1,29 +1,29 @@
|
||||
<p>
|
||||
<a href="https://github.com/youzan/"><img alt="logo" width="36px" src="https://img.yzcdn.cn/public_files/2017/02/09/e84aa8cbbf7852688c86218c1f3bbf17.png" alt="youzan">
|
||||
<a href="https://github.com/youzan/"><img alt="logo" width="36" height="36" src="https://img.yzcdn.cn/public_files/2017/02/09/e84aa8cbbf7852688c86218c1f3bbf17.png" alt="youzan">
|
||||
</a>
|
||||
</p>
|
||||
<p align="center">
|
||||
<img alt="logo" src="https://img.yzcdn.cn/public_files/2017/12/18/fd78cf6bb5d12e2a119d0576bedfd230.png" width="120" style="margin-bottom: 10px;">
|
||||
<img alt="logo" src="https://img.yzcdn.cn/public_files/2017/12/18/fd78cf6bb5d12e2a119d0576bedfd230.png" width="120" height="120" style="margin-bottom: 10px;">
|
||||
</p>
|
||||
|
||||
<p align="center">A Vue.js 2.0 Mobile UI at YouZan</p>
|
||||
|
||||
[](https://travis-ci.org/youzan/vant)
|
||||
[](https://www.npmjs.com/package/vant)
|
||||
[](https://travis-ci.org/youzan/vant)
|
||||
[](https://www.npmjs.com/package/vant)
|
||||
[](https://codecov.io/github/youzan/vant?branch=dev)
|
||||
[](https://www.npmjs.com/package/vant)
|
||||
[](https://www.npmjs.com/package/vant)
|
||||
[](https://www.npmjs.com/package/vant)
|
||||
|
||||
|
||||
[访问中文版](./README.zh-CN.md)
|
||||
|
||||
## Features
|
||||
|
||||
- 45+ Reusable components
|
||||
- 90%+ Unit test coverage
|
||||
- Extensive documentation and demos
|
||||
- Support [babel-plugin-import](https://github.com/ant-design/babel-plugin-import)
|
||||
- Support TypeScript
|
||||
- Support SSR
|
||||
* 48+ Reusable components
|
||||
* 90%+ Unit test coverage
|
||||
* Extensive documentation and demos
|
||||
* Support [babel-plugin-import](https://github.com/ant-design/babel-plugin-import)
|
||||
* Support TypeScript
|
||||
* Support SSR
|
||||
|
||||
<p align="center">
|
||||
<img alt="components preview" src="https://img.yzcdn.cn/public_files/2017/12/05/95f5ee7524b7845abb2f51803a01d65e.png">
|
||||
@@ -34,10 +34,11 @@
|
||||
```shell
|
||||
npm i -S vant
|
||||
```
|
||||
|
||||
|
||||
## Quickstart
|
||||
|
||||
#### 1. Use [babel-plugin-import](https://github.com/ant-design/babel-plugin-import) (Recommended)
|
||||
|
||||
```bash
|
||||
# Install babel-plugin-import
|
||||
npm i babel-plugin-import -D
|
||||
@@ -65,7 +66,7 @@ import { Button } from 'vant/lib/button';
|
||||
import 'vant/lib/vant-css/base.css';
|
||||
import 'vant/lib/vant-css/button.css';
|
||||
```
|
||||
|
||||
|
||||
#### 3. Import all components
|
||||
|
||||
```js
|
||||
@@ -87,25 +88,29 @@ Vue.use(Vant);
|
||||
```
|
||||
|
||||
See more in [Quickstart](https://www.youzanyun.com/zanui/vant#/en-US/component/quickstart).
|
||||
|
||||
|
||||
## Contribution
|
||||
|
||||
Please make sure to read the [Contributing Guide](./.github/CONTRIBUTING.md) before making a pull request.
|
||||
|
||||
## Browser Support
|
||||
|
||||
Modern browsers and Android 4.0+, iOS 6+.
|
||||
|
||||
## Links
|
||||
- [Documentation](https://www.youzanyun.com/zanui/vant)
|
||||
- [Changelog](https://www.youzanyun.com/zanui/vant#/en-US/component/changelog)
|
||||
- [Weapp UI](https://github.com/youzan/zanui-weapp)
|
||||
- [Vant Demo](https://github.com/youzan/vant-demo)
|
||||
- [vue-cli-template-vant](https://github.com/youzan/vue-cli-template-vant)
|
||||
|
||||
|
||||
* [Documentation](https://www.youzanyun.com/zanui/vant)
|
||||
* [Changelog](https://www.youzanyun.com/zanui/vant#/en-US/component/changelog)
|
||||
* [Weapp UI](https://github.com/youzan/zanui-weapp)
|
||||
* [Vant Demo](https://github.com/youzan/vant-demo)
|
||||
* [vue-cli-template-vant](https://github.com/youzan/vue-cli-template-vant)
|
||||
|
||||
## Preview
|
||||
|
||||
You can scan the following QR code to access the demo:
|
||||
|
||||

|
||||
|
||||
|
||||
## LICENSE
|
||||
|
||||
[MIT](https://zh.wikipedia.org/wiki/MIT%E8%A8%B1%E5%8F%AF%E8%AD%89)
|
||||
|
Reference in New Issue
Block a user