Skip to content

Commit

Permalink
docs: add tip for yarn 2 (close #200)
Browse files Browse the repository at this point in the history
  • Loading branch information
meteorlxy committed Jun 12, 2021
1 parent 70e9a57 commit 7d3f3a4
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
3 changes: 2 additions & 1 deletion docs/guide/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@
- [Yarn v1 classic](https://classic.yarnpkg.com/en/) (Optional)

::: tip
If you are using [pnpm](https://pnpm.io/), you may need to enable [shamefully-hoist](https://pnpm.io/npmrc#shamefully-hoist) to avoid potential issues.
- With [pnpm](https://pnpm.io/), you need to set `shamefully-hoist=true` in your [`.npmrc`](https://pnpm.io/npmrc#shamefully-hoist) file.
- With [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
3 changes: 2 additions & 1 deletion docs/zh/guide/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@
- [Yarn v1 classic](https://classic.yarnpkg.com/zh-Hans/) (可选)

::: tip
如果你使用的是 [pnpm](https://pnpm.io/) ,你可能需要启用 [shamefully-hoist](https://pnpm.io/npmrc#shamefully-hoist) 来避免一些潜在的问题。
- 使用 [pnpm](https://pnpm.io/zh/) 时,你需要在 [`.npmrc`](https://pnpm.io/zh/npmrc#shamefully-hoist) 文件中设置 `shamefully-hoist=true`
- 使用 [yarn 2](https://yarnpkg.com/) 时,你需要在 [`.yarnrc.yml`](https://yarnpkg.com/configuration/yarnrc#nodeLinker) 文件中设置 `nodeLinker: 'node-modules'`
:::

## 手动安装
Expand Down

0 comments on commit 7d3f3a4

Please sign in to comment.