Skip to content

Commit

Permalink
docs: update package manager guide
Browse files Browse the repository at this point in the history
  • Loading branch information
meteorlxy committed Oct 11, 2023
1 parent 19e12f8 commit 082fe57
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 7 deletions.
8 changes: 5 additions & 3 deletions docs/guide/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
9 changes: 5 additions & 4 deletions docs/zh/guide/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -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'`

:::

## 手动安装

Expand Down

0 comments on commit 082fe57

Please sign in to comment.