Skip to content

Commit f7a78b4

Browse files
committed
docs: update guide for project bootstrap
1 parent 3551e69 commit f7a78b4

File tree

5 files changed

+7
-11
lines changed

5 files changed

+7
-11
lines changed

Diff for: .github/CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ yarn test
1818
# Clean dependencies.
1919
yarn clean
2020

21-
# Useful when creating new submodules.
21+
# Useful when creating new a package.
2222
yarn boot
2323
```
2424

Diff for: .gitpod.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@ ports:
22
- port: 8080
33
onOpen: open-preview
44
tasks:
5-
- init: yarn bootstrap
5+
- init: yarn
66
command: yarn dev

Diff for: packages/docs/docs/miscellaneous/local-development.md

+2-4
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ VuePress is using a combo with [Yarn workspaces](https://yarnpkg.com/lang/en/doc
1313
## Init packages
1414

1515
```bash
16-
yarn bootstrap // it will run and install into the root all packages subfolders
16+
yarn // it will install dependencies of all packages
1717
```
1818

19-
`yarn bootstrap` will use hoisting. What does it mean for you ?
19+
`yarn` will use hoisting. What does it mean for you ?
2020

2121
It will regroup all dependencies in the workspace root and link all packages.
2222

@@ -26,8 +26,6 @@ Check the link by running the following command:
2626
ls -la node_modules/@vuepress
2727
```
2828

29-
You will all symlinks
30-
3129
:::warning
3230
You have to take care to declare all dependencies inside subFolders package.json. When publish the lib if dependencies from a package is not declare it will just not work.
3331
:::

Diff for: packages/docs/docs/zh/miscellaneous/local-development.md

+2-4
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ VuePress 正在使用包含了 [Yarn Workspaces](https://yarnpkg.com/zh-Hans/doc
1313
## 初始化 package
1414

1515
```bash
16-
yarn bootstrap // 它将运行并安装根目录和所有 package 的依赖
16+
yarn // 它将安装所有 package 的依赖
1717
```
1818

19-
`yarn bootstrap` 将使用 `hoist`。它对你意味着什么?
19+
`yarn` 将使用 `hoist`。它对你意味着什么?
2020

2121
它将重组工作空间根目录中的所有依赖项并链接所有 package。
2222

@@ -26,8 +26,6 @@ VuePress 正在使用包含了 [Yarn Workspaces](https://yarnpkg.com/zh-Hans/doc
2626
ls -la node_modules/@vuepress
2727
```
2828

29-
你将全部链接完成。
30-
3129
::: warning
3230
你必须注意应在子文件夹的 package.json 中声明所有依赖项。如果未声明 package 的 dependencies,则在发布到 npm 时将无法正常工作。
3331
:::

Diff for: packages/vuepress/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ The docs are available at <https://vuepress.vuejs.org>
3232
Want to contribute? Check our [issues for beginners](https://github.com/vuejs/vuepress/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)!
3333

3434
```bash
35-
yarn bootstrap # Install and link dependencies for this lerna repo
35+
yarn # Install and link dependencies for this monorepo
3636
yarn dev # serves VuePress' own docs with itself
3737
yarn test # make sure your code change pass the test
3838
```

0 commit comments

Comments
 (0)