mirror of
https://gitee.com/vant-contrib/vant.git
synced 2025-04-05 05:42:44 +08:00
docs: update readme (#10868)
This commit is contained in:
parent
e6b43db90b
commit
41d6b5191d
@ -4,14 +4,13 @@
|
|||||||
|
|
||||||
<h1 align="center">Vant</h1>
|
<h1 align="center">Vant</h1>
|
||||||
|
|
||||||
<p align="center">Mobile UI Components built on Vue</p>
|
<p align="center">Lightweight Mobile UI Components built on Vue</p>
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<img src="https://img.shields.io/npm/v/vant?style=flat-square" alt="npm version" />
|
<img src="https://img.shields.io/npm/v/vant?style=flat-square" alt="npm version" />
|
||||||
<img src="https://img.shields.io/github/workflow/status/vant-ui/vant/CI/dev?style=flat-square" alt="CI Status" />
|
<img src="https://img.shields.io/github/workflow/status/vant-ui/vant/CI/dev?style=flat-square" alt="CI Status" />
|
||||||
<img src="https://img.shields.io/codecov/c/github/vant-ui/vant/dev.svg?style=flat-square&color=#4fc08d" alt="Coverage Status" />
|
<img src="https://img.shields.io/codecov/c/github/vant-ui/vant/dev.svg?style=flat-square&color=#4fc08d" alt="Coverage Status" />
|
||||||
<img src="https://img.shields.io/npm/dm/vant.svg?style=flat-square&color=#4fc08d" alt="downloads" />
|
<img src="https://img.shields.io/npm/dm/vant.svg?style=flat-square&color=#4fc08d" alt="downloads" />
|
||||||
<img src="https://img.shields.io/jsdelivr/npm/hm/vant?style=flat-square" alt="Jsdelivr Hits">
|
|
||||||
<img src="https://img.badgesize.io/https://unpkg.com/vant@3/lib/vant.min.js?compression=gzip&style=flat-square&label=gzip%20size&color=#4fc08d" alt="Gzip Size" />
|
<img src="https://img.badgesize.io/https://unpkg.com/vant@3/lib/vant.min.js?compression=gzip&style=flat-square&label=gzip%20size&color=#4fc08d" alt="Gzip Size" />
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
@ -29,6 +28,7 @@
|
|||||||
|
|
||||||
- 🚀 1KB Component average size (min+gzip)
|
- 🚀 1KB Component average size (min+gzip)
|
||||||
- 🚀 70+ High quality components
|
- 🚀 70+ High quality components
|
||||||
|
- 🚀 Zero third-party dependencies
|
||||||
- 💪 90%+ Unit test coverage
|
- 💪 90%+ Unit test coverage
|
||||||
- 💪 Written in TypeScript
|
- 💪 Written in TypeScript
|
||||||
- 📖 Extensive documentation and demos
|
- 📖 Extensive documentation and demos
|
||||||
|
@ -11,7 +11,6 @@
|
|||||||
<img src="https://img.shields.io/github/workflow/status/vant-ui/vant/CI/dev?style=flat-square" alt="CI Status" />
|
<img src="https://img.shields.io/github/workflow/status/vant-ui/vant/CI/dev?style=flat-square" alt="CI Status" />
|
||||||
<img src="https://img.shields.io/codecov/c/github/vant-ui/vant/dev.svg?style=flat-square&color=#4fc08d" alt="Coverage Status" />
|
<img src="https://img.shields.io/codecov/c/github/vant-ui/vant/dev.svg?style=flat-square&color=#4fc08d" alt="Coverage Status" />
|
||||||
<img src="https://img.shields.io/npm/dm/vant.svg?style=flat-square&color=#4fc08d" alt="downloads" />
|
<img src="https://img.shields.io/npm/dm/vant.svg?style=flat-square&color=#4fc08d" alt="downloads" />
|
||||||
<img src="https://img.shields.io/jsdelivr/npm/hm/vant?style=flat-square" alt="Jsdelivr Hits">
|
|
||||||
<img src="https://img.badgesize.io/https://unpkg.com/vant@3/lib/vant.min.js?compression=gzip&style=flat-square&label=gzip%20size&color=#4fc08d" alt="Gzip Size" />
|
<img src="https://img.badgesize.io/https://unpkg.com/vant@3/lib/vant.min.js?compression=gzip&style=flat-square&label=gzip%20size&color=#4fc08d" alt="Gzip Size" />
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
@ -33,6 +32,7 @@ Vant 是一个**轻量、可靠的移动端组件库**,于 2017 年开源。
|
|||||||
|
|
||||||
- 🚀 性能极佳,组件平均体积小于 1KB(min+gzip)
|
- 🚀 性能极佳,组件平均体积小于 1KB(min+gzip)
|
||||||
- 🚀 70+ 个高质量组件,覆盖移动端主流场景
|
- 🚀 70+ 个高质量组件,覆盖移动端主流场景
|
||||||
|
- 🚀 零外部依赖,不依赖三方 npm 包
|
||||||
- 💪 使用 TypeScript 编写,提供完整的类型定义
|
- 💪 使用 TypeScript 编写,提供完整的类型定义
|
||||||
- 💪 单元测试覆盖率超过 90%,提供稳定性保障
|
- 💪 单元测试覆盖率超过 90%,提供稳定性保障
|
||||||
- 📖 提供丰富的中英文文档和组件示例
|
- 📖 提供丰富的中英文文档和组件示例
|
||||||
|
@ -1,9 +1,10 @@
|
|||||||
# Vant CLI
|
# Vant CLI
|
||||||
|
|
||||||
Vant CLI 是一个 Vue 组件库构建工具,通过 Vant CLI 可以快速搭建一套功能完备的 Vue 组件库。
|
Vant CLI 是一个基于 Vite 实现的 Vue 组件库构建工具,通过 Vant CLI 可以快速搭建一套功能完备的 Vue 组件库。
|
||||||
|
|
||||||
### 特性
|
### 特性
|
||||||
|
|
||||||
|
- 基于 Vite 实现,享受愉悦的开发体验
|
||||||
- 提供丰富的命令,涵盖从开发测试到构建发布的完整流程
|
- 提供丰富的命令,涵盖从开发测试到构建发布的完整流程
|
||||||
- 基于约定的目录结构,自动生成优雅的文档站点和组件示例
|
- 基于约定的目录结构,自动生成优雅的文档站点和组件示例
|
||||||
- 内置 ESLint 校验规则,提交代码时自动执行校验
|
- 内置 ESLint 校验规则,提交代码时自动执行校验
|
||||||
|
@ -2,7 +2,7 @@
|
|||||||
<div class="van-doc-intro">
|
<div class="van-doc-intro">
|
||||||
<img class="van-doc-intro__logo" style="width: 120px; height: 120px;" src="https://fastly.jsdelivr.net/npm/@vant/assets/logo.png">
|
<img class="van-doc-intro__logo" style="width: 120px; height: 120px;" src="https://fastly.jsdelivr.net/npm/@vant/assets/logo.png">
|
||||||
<h2 style="margin: 0; font-size: 36px; line-height: 60px;">Vant</h2>
|
<h2 style="margin: 0; font-size: 36px; line-height: 60px;">Vant</h2>
|
||||||
<p>Mobile UI Components built on Vue</p>
|
<p>Lightweight Mobile UI Components built on Vue</p>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
@ -10,6 +10,7 @@
|
|||||||
|
|
||||||
- 🚀 1KB Component average size (min+gzip)
|
- 🚀 1KB Component average size (min+gzip)
|
||||||
- 🚀 70+ High quality components
|
- 🚀 70+ High quality components
|
||||||
|
- 🚀 Zero third-party dependencies
|
||||||
- 💪 90%+ Unit test coverage
|
- 💪 90%+ Unit test coverage
|
||||||
- 💪 Written in TypeScript
|
- 💪 Written in TypeScript
|
||||||
- 📖 Extensive documentation and demos
|
- 📖 Extensive documentation and demos
|
||||||
|
@ -16,6 +16,7 @@ Vant 是一个**轻量、可靠的移动端组件库**,于 2017 年开源。
|
|||||||
|
|
||||||
- 🚀 性能极佳,组件平均体积小于 1KB(min+gzip)
|
- 🚀 性能极佳,组件平均体积小于 1KB(min+gzip)
|
||||||
- 🚀 70+ 个高质量组件,覆盖移动端主流场景
|
- 🚀 70+ 个高质量组件,覆盖移动端主流场景
|
||||||
|
- 🚀 零外部依赖,不依赖三方 npm 包
|
||||||
- 💪 使用 TypeScript 编写,提供完整的类型定义
|
- 💪 使用 TypeScript 编写,提供完整的类型定义
|
||||||
- 💪 单元测试覆盖率超过 90%,提供稳定性保障
|
- 💪 单元测试覆盖率超过 90%,提供稳定性保障
|
||||||
- 📖 提供丰富的中英文文档和组件示例
|
- 📖 提供丰富的中英文文档和组件示例
|
||||||
|
@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"name": "vant",
|
"name": "vant",
|
||||||
"version": "3.5.2",
|
"version": "3.5.2",
|
||||||
"description": "Mobile UI Components built on Vue",
|
"description": "Lightweight Mobile UI Components built on Vue",
|
||||||
"main": "lib/vant.cjs.js",
|
"main": "lib/vant.cjs.js",
|
||||||
"module": "es/index.mjs",
|
"module": "es/index.mjs",
|
||||||
"style": "lib/index.css",
|
"style": "lib/index.css",
|
||||||
|
@ -458,7 +458,7 @@ export default {
|
|||||||
'en-US': {
|
'en-US': {
|
||||||
title: 'Vant 3',
|
title: 'Vant 3',
|
||||||
subtitle: ' (for Vue 3)',
|
subtitle: ' (for Vue 3)',
|
||||||
description: 'Mobile UI Components built on Vue',
|
description: 'Lightweight Mobile UI Components built on Vue',
|
||||||
logo: 'https://fastly.jsdelivr.net/npm/@vant/assets/logo.png',
|
logo: 'https://fastly.jsdelivr.net/npm/@vant/assets/logo.png',
|
||||||
langLabel: 'EN',
|
langLabel: 'EN',
|
||||||
links: [
|
links: [
|
||||||
|
Loading…
x
Reference in New Issue
Block a user