From 082fe57bb36031a88a1b5ebb0553f248f3926a52 Mon Sep 17 00:00:00 2001 From: meteorlxy Date: Wed, 11 Oct 2023 15:27:02 +0800 Subject: [PATCH] docs: update package manager guide --- docs/guide/getting-started.md | 8 +++++--- docs/zh/guide/getting-started.md | 9 +++++---- 2 files changed, 10 insertions(+), 7 deletions(-) diff --git a/docs/guide/getting-started.md b/docs/guide/getting-started.md index 815cac09ad..19bb48de28 100644 --- a/docs/guide/getting-started.md +++ b/docs/guide/getting-started.md @@ -7,11 +7,13 @@ VuePress v2 is currently in `beta` stage. It's ready to be used for building you ## Prerequisites - [Node.js v18.16.0+](https://nodejs.org/) -- [Yarn v1 classic](https://classic.yarnpkg.com/en/) (Optional) +- Package manager like [pnpm](https://pnpm.io), [yarn](https://classic.yarnpkg.com/en/), [npm](https://www.npmjs.com), etc. ::: tip -- With [pnpm](https://pnpm.io/), you may need to install `vue` and `@vuepress/client` as peer-dependencies, i.e. `pnpm add -D vue @vuepress/client@next`. -- With [yarn 2](https://yarnpkg.com/), you need to set `nodeLinker: 'node-modules'` in your [`.yarnrc.yml`](https://yarnpkg.com/configuration/yarnrc#nodeLinker) file. + +- When using [pnpm](https://pnpm.io/), you need to install `vue` and `@vuepress/client` as peer-dependencies. +- When using [yarn 2+](https://yarnpkg.com/), you need to set `nodeLinker: 'node-modules'` in your [`.yarnrc.yml`](https://yarnpkg.com/configuration/yarnrc#nodeLinker) file. + ::: ## Manual Installation diff --git a/docs/zh/guide/getting-started.md b/docs/zh/guide/getting-started.md index e8bdadbf2e..daa4f90b4a 100644 --- a/docs/zh/guide/getting-started.md +++ b/docs/zh/guide/getting-started.md @@ -7,13 +7,14 @@ VuePress v2 目前仍处于 `beta` 阶段。你已经可以用它来构建你的 ## 依赖环境 - [Node.js v18.16.0+](https://nodejs.org/) -- [Yarn v1 classic](https://classic.yarnpkg.com/zh-Hans/) （可选） +- 包管理器，如 [pnpm](https://pnpm.io/zh/)、[yarn](https://classic.yarnpkg.com/en/)、[npm](https://www.npmjs.com/) 等。 ::: tip -- 使用 [pnpm](https://pnpm.io/zh/) 时，你可能需要安装 `vue` 和 `@vuepress/client` 作为 peer-dependencies ，即 `pnpm add -D vue @vuepress/client@next` 。 -- 使用 [yarn 2](https://yarnpkg.com/) 时，你需要在 [`.yarnrc.yml`](https://yarnpkg.com/configuration/yarnrc#nodeLinker) 文件中设置 `nodeLinker: 'node-modules'` 。 - ::: +- 使用 [pnpm](https://pnpm.io/zh/) 时，你需要安装 `vue` 和 `@vuepress/client` 作为 peer-dependencies 。 +- 使用 [yarn 2+](https://yarnpkg.com/) 时，你需要在 [`.yarnrc.yml`](https://yarnpkg.com/configuration/yarnrc#nodeLinker) 文件中设置 `nodeLinker: 'node-modules'` 。 + +::: ## 手动安装