From 0e0339ef6b224e0ba3525a736785b4f42fd5a19c Mon Sep 17 00:00:00 2001 From: neverland Date: Fri, 17 Dec 2021 20:48:16 +0800 Subject: [PATCH] docs: add vant use install guide (#10058) --- .../vant/docs/markdown/vant-use-intro.en-US.md | 15 +++++++++++++++ .../vant/docs/markdown/vant-use-intro.zh-CN.md | 17 ++++++++++++++++- 2 files changed, 31 insertions(+), 1 deletion(-) diff --git a/packages/vant/docs/markdown/vant-use-intro.en-US.md b/packages/vant/docs/markdown/vant-use-intro.en-US.md index 5797982c7..647195f23 100644 --- a/packages/vant/docs/markdown/vant-use-intro.en-US.md +++ b/packages/vant/docs/markdown/vant-use-intro.en-US.md @@ -4,6 +4,21 @@ Vant provide some built-in composition APIs, you can directly use these APIs for development. +### Install + +Although `@vant/use` is already included in Vant's dependencies, it is still recommended to install this package explicitly: + +```shell +# with npm +npm i @vant/use + +# with yarn +yarn add @vant/use + +# with pnpm +pnpm add @vant/use +``` + ### Demo ```js diff --git a/packages/vant/docs/markdown/vant-use-intro.zh-CN.md b/packages/vant/docs/markdown/vant-use-intro.zh-CN.md index 03a548a50..2b3df5a35 100644 --- a/packages/vant/docs/markdown/vant-use-intro.zh-CN.md +++ b/packages/vant/docs/markdown/vant-use-intro.zh-CN.md @@ -2,7 +2,22 @@ ### 介绍 -Vant 内置了一系列的组合式 API,对于安装了 `vant` 的项目,可以直接使用这些 API 进行开发。 +Vant 底层依赖了 `@vant/use` 包,其中内置了一系列的组合式 API。对于使用了 Vant 的项目,可以复用这些 API 进行开发。 + +### 安装 + +虽然 Vant 的依赖中已经包含了 `@vant/use`,但我们仍然推荐显式地安装它: + +```shell +# with npm +npm i @vant/use + +# with yarn +yarn add @vant/use + +# with pnpm +pnpm add @vant/use +``` ### 示例