Skip to content

Commit de37e95

Browse files
committed
docs: clarify installation instructions (close: #1380)
1 parent 1a928c7 commit de37e95

30 files changed

+60
-58
lines changed

Diff for: packages/docs/docs/guide/getting-started.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ If you just want to play around with VuePress, you can install it globally:
1010

1111
``` bash
1212
# install globally
13-
yarn global add vuepress # OR npm install -g vuepress
13+
yarn global add vuepress@next # OR npm install -g vuepress@next
1414

1515
# create a markdown file
1616
echo '# Hello VuePress' > README.md
@@ -28,7 +28,7 @@ If you have an existing project and would like to keep documentation inside the
2828

2929
``` bash
3030
# install as a local dependency
31-
yarn add -D vuepress # OR npm install -D vuepress
31+
yarn add -D vuepress@next # OR npm install -D vuepress@next
3232

3333
# create a docs directory
3434
mkdir docs

Diff for: packages/docs/docs/miscellaneous/migration-guide.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@ GA has been separated into a standalone plugin [@vuepress/plugin-google-analytic
1515
1. Install `@vuepress/plugin-google-analytics`:
1616

1717
```bash
18-
yarn add -D @vuepress/plugin-google-analytics
18+
yarn add -D @vuepress/plugin-google-analytics@next
19+
# OR npm install -D @vuepress/plugin-google-analytics@next
1920
```
2021

2122
2. Update `vuepress/config.js`:

Diff for: packages/docs/docs/plugin/official/plugin-active-header-links.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ metaTitle: A plugin of automatically activating sidebar links when page scrolls
1010
## Install
1111

1212
```bash
13-
yarn add -D @vuepress/plugin-active-header-links
14-
# OR npm install -D @vuepress/plugin-active-header-links
13+
yarn add -D @vuepress/plugin-active-header-links@next
14+
# OR npm install -D @vuepress/plugin-active-header-links@next
1515
```
1616

1717
## Usage

Diff for: packages/docs/docs/plugin/official/plugin-back-to-top.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ metaTitle: Back-To-Top Plugin | VuePress
1010
## Install
1111

1212
```bash
13-
yarn add -D @vuepress/plugin-back-to-top
14-
# OR npm install -D @vuepress/plugin-back-to-top
13+
yarn add -D @vuepress/plugin-back-to-top@next
14+
# OR npm install -D @vuepress/plugin-back-to-top@next
1515
```
1616

1717
## Usage

Diff for: packages/docs/docs/plugin/official/plugin-blog.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ metaTitle: Blog Plugin | VuePress
1010
## Install
1111

1212
```bash
13-
yarn add -D @vuepress/plugin-blog
14-
# OR npm install -D @vuepress/plugin-blog
13+
yarn add -D @vuepress/plugin-blog@next
14+
# OR npm install -D @vuepress/plugin-blog@next
1515
```
1616

1717
## Usage

Diff for: packages/docs/docs/plugin/official/plugin-clean-urls.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ metaTitle: A plugin of automatically generating clean urls | VuePress
1010
## Install
1111

1212
```bash
13-
yarn add -D @vuepress/plugin-clean-urls
14-
# OR npm install -D @vuepress/plugin-clean-urls
13+
yarn add -D @vuepress/plugin-clean-urls@next
14+
# OR npm install -D @vuepress/plugin-clean-urls@next
1515
```
1616

1717
## Usage

Diff for: packages/docs/docs/plugin/official/plugin-container.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ metaTitle: A plugin of registering markdown containers | VuePress
1010
## Install
1111

1212
```bash
13-
yarn add -D @vuepress/plugin-container
14-
# OR npm install -D @vuepress/plugin-container
13+
yarn add -D @vuepress/plugin-container@next
14+
# OR npm install -D @vuepress/plugin-container@next
1515
```
1616

1717
## Usage

Diff for: packages/docs/docs/plugin/official/plugin-google-analytics.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ metaTitle: Google Analytics Plugin | VuePress
1111
## Install
1212

1313
```bash
14-
yarn add -D @vuepress/plugin-google-analytics
15-
# OR npm install -D @vuepress/plugin-google-analytics
14+
yarn add -D @vuepress/plugin-google-analytics@next
15+
# OR npm install -D @vuepress/plugin-google-analytics@next
1616
```
1717

1818
## Usage

Diff for: packages/docs/docs/plugin/official/plugin-i18n-ui.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ metaTitle: I18n-UI Plugin | VuePress
1010
## Install
1111

1212
```bash
13-
yarn add -D @vuepress/plugin-i18n-ui
14-
# OR npm install -D @vuepress/plugin-i18n-ui
13+
yarn add -D @vuepress/plugin-i18n-ui@next
14+
# OR npm install -D @vuepress/plugin-i18n-ui@next
1515
```
1616

1717
## Usage

Diff for: packages/docs/docs/plugin/official/plugin-medium-zoom.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ metaTitle: Medium-Zoom Plugin | VuePress
1010
## Install
1111

1212
```bash
13-
yarn add -D @vuepress/plugin-medium-zoom
14-
# OR npm install -D @vuepress/plugin-medium-zoom
13+
yarn add -D @vuepress/plugin-medium-zoom@next
14+
# OR npm install -D @vuepress/plugin-medium-zoom@next
1515
```
1616

1717
## Usage

Diff for: packages/docs/docs/plugin/official/plugin-nprogress.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ metaTitle: Nprogress Plugin | VuePress
1010
## Install
1111

1212
```bash
13-
yarn add -D @vuepress/plugin-nprogress
14-
# OR npm install -D @vuepress/plugin-nprogress
13+
yarn add -D @vuepress/plugin-nprogress@next
14+
# OR npm install -D @vuepress/plugin-nprogress@next
1515
```
1616

1717
## Usage

Diff for: packages/docs/docs/plugin/official/plugin-pagination.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ metaTitle: Pagination Plugin | VuePress
1010
## Install
1111

1212
```bash
13-
yarn add -D @vuepress/plugin-pagination
14-
# OR npm install -D @vuepress/plugin-pagination
13+
yarn add -D @vuepress/plugin-pagination@next
14+
# OR npm install -D @vuepress/plugin-pagination@next
1515
```
1616

1717
## Usage

Diff for: packages/docs/docs/plugin/official/plugin-pwa.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ metaTitle: PWA Plugin | VuePress
1010
## Install
1111

1212
```bash
13-
yarn add -D @vuepress/plugin-pwa
14-
# OR npm install -D @vuepress/plugin-pwa
13+
yarn add -D @vuepress/plugin-pwa@next
14+
# OR npm install -D @vuepress/plugin-pwa@next
1515
```
1616

1717
## Usage

Diff for: packages/docs/docs/plugin/official/plugin-register-components.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ metaTitle: Register Components Plugin | VuePress
1010
## Install
1111

1212
```bash
13-
yarn add -D @vuepress/plugin-register-components
14-
# OR npm install -D @vuepress/plugin-register-components
13+
yarn add -D @vuepress/plugin-register-components@next
14+
# OR npm install -D @vuepress/plugin-register-components@next
1515
```
1616

1717
## Usage

Diff for: packages/docs/docs/plugin/official/plugin-search.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ metaTitle: Search Plugin | VuePress
1010
## Install
1111

1212
```bash
13-
yarn add -D @vuepress/plugin-search
14-
# OR npm install -D @vuepress/plugin-search
13+
yarn add -D @vuepress/plugin-search@next
14+
# OR npm install -D @vuepress/plugin-search@next
1515
```
1616

1717
::: tip

Diff for: packages/docs/docs/zh/guide/getting-started.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
``` bash
1212
# 安装
13-
yarn global add vuepress # 或者:npm install -g vuepress
13+
yarn global add vuepress@next # 或者:npm install -g vuepress@next
1414

1515
# 新建一个 markdown 文件
1616
echo '# Hello VuePress!' > README.md
@@ -28,7 +28,7 @@ vuepress build .
2828

2929
``` bash
3030
# 将 VuePress 作为一个本地依赖安装
31-
yarn add -D vuepress # 或者:npm install -D vuepress
31+
yarn add -D vuepress@next # 或者:npm install -D vuepress@next
3232

3333
# 新建一个 docs 文件夹
3434
mkdir docs

Diff for: packages/docs/docs/zh/miscellaneous/migration-guide.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@ GA 已经被分离为一个单独的插件 [@vuepress/plugin-google-analytics](.
1515
1. 安装 `@vuepress/plugin-google-analytics`:
1616

1717
```bash
18-
yarn add -D @vuepress/plugin-google-analytics
18+
yarn add -D @vuepress/plugin-google-analytics@next
19+
# OR npm install -D @vuepress/plugin-google-analytics@next
1920
```
2021

2122
2. 更新 `vuepress/config.js`:

Diff for: packages/docs/docs/zh/plugin/official/plugin-active-header-links.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ metaTitle: 页面滚动时自动激活侧边栏链接的插件 | VuePress
1010
## 安装
1111

1212
```bash
13-
yarn add -D @vuepress/plugin-active-header-links
14-
# OR npm install -D @vuepress/plugin-active-header-links
13+
yarn add -D @vuepress/plugin-active-header-links@next
14+
# OR npm install -D @vuepress/plugin-active-header-links@next
1515
```
1616

1717
## 使用

Diff for: packages/docs/docs/zh/plugin/official/plugin-back-to-top.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ metaTitle: Back-To-Top 插件 | VuePress
1010
## 安装
1111

1212
```bash
13-
yarn add -D @vuepress/plugin-back-to-top
14-
# OR npm install -D @vuepress/plugin-back-to-top
13+
yarn add -D @vuepress/plugin-back-to-top@next
14+
# OR npm install -D @vuepress/plugin-back-to-top@next
1515
```
1616

1717
## 使用

Diff for: packages/docs/docs/zh/plugin/official/plugin-blog.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ metaTitle: Blog 插件 | VuePress
1010
## 安装
1111

1212
```bash
13-
yarn add -D @vuepress/plugin-blog
14-
# OR npm install -D @vuepress/plugin-blog
13+
yarn add -D @vuepress/plugin-blog@next
14+
# OR npm install -D @vuepress/plugin-blog@next
1515
```
1616

1717
## 使用

Diff for: packages/docs/docs/zh/plugin/official/plugin-clean-urls.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ metaTitle: 自动生成简洁链接的插件 | VuePress
1010
## 安装
1111

1212
```bash
13-
yarn add -D @vuepress/plugin-clean-urls
14-
# OR npm install -D @vuepress/plugin-clean-urls
13+
yarn add -D @vuepress/plugin-clean-urls@next
14+
# OR npm install -D @vuepress/plugin-clean-urls@next
1515
```
1616

1717
## 使用

Diff for: packages/docs/docs/zh/plugin/official/plugin-container.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ metaTitle: Markdown 容器插件 | VuePress
1010
## 安装
1111

1212
```bash
13-
yarn add -D @vuepress/plugin-container
14-
# OR npm install -D @vuepress/plugin-container
13+
yarn add -D @vuepress/plugin-container@next
14+
# OR npm install -D @vuepress/plugin-container@next
1515
```
1616

1717
## 使用

Diff for: packages/docs/docs/zh/plugin/official/plugin-google-analytics.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ metaTitle: Google Analytics 插件 | VuePress
1010
## 安装
1111

1212
```bash
13-
yarn add -D @vuepress/plugin-google-analytics
14-
# OR npm install -D @vuepress/plugin-google-analytics
13+
yarn add -D @vuepress/plugin-google-analytics@next
14+
# OR npm install -D @vuepress/plugin-google-analytics@next
1515
```
1616

1717
## 使用

Diff for: packages/docs/docs/zh/plugin/official/plugin-i18n-ui.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ metaTitle: I18n-UI 插件 | VuePress
1010
## 安装
1111

1212
```bash
13-
yarn add -D @vuepress/plugin-i18n-ui
14-
# OR npm install -D @vuepress/plugin-i18n-ui
13+
yarn add -D @vuepress/plugin-i18n-ui@next
14+
# OR npm install -D @vuepress/plugin-i18n-ui@next
1515
```
1616

1717
## 使用

Diff for: packages/docs/docs/zh/plugin/official/plugin-medium-zoom.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ metaTitle: Medium-Zoom 插件 | VuePress
1010
## 安装
1111

1212
```bash
13-
yarn add -D @vuepress/plugin-medium-zoom
14-
# OR npm install -D @vuepress/plugin-medium-zoom
13+
yarn add -D @vuepress/plugin-medium-zoom@next
14+
# OR npm install -D @vuepress/plugin-medium-zoom@next
1515
```
1616

1717
## 使用

Diff for: packages/docs/docs/zh/plugin/official/plugin-nprogress.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ metaTitle: Nprogress 插件 | VuePress
1010
## 安装
1111

1212
```bash
13-
yarn add -D @vuepress/plugin-nprogress
14-
# 或者 npm install -D @vuepress/plugin-nprogress
13+
yarn add -D @vuepress/plugin-nprogress@next
14+
# 或者 npm install -D @vuepress/plugin-nprogress@next
1515
```
1616

1717
## 使用

Diff for: packages/docs/docs/zh/plugin/official/plugin-pagination.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ metaTitle: Pagination 插件 | VuePress
1010
## 安装
1111

1212
```bash
13-
yarn add -D @vuepress/plugin-pagination
14-
# OR npm install -D @vuepress/plugin-pagination
13+
yarn add -D @vuepress/plugin-pagination@next
14+
# OR npm install -D @vuepress/plugin-pagination@next
1515
```
1616

1717
## 使用

Diff for: packages/docs/docs/zh/plugin/official/plugin-pwa.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ metaTitle: PWA 插件 | VuePress
1010
## 安装
1111

1212
```bash
13-
yarn add -D @vuepress/plugin-pwa
14-
# OR npm install -D @vuepress/plugin-pwa
13+
yarn add -D @vuepress/plugin-pwa@next
14+
# OR npm install -D @vuepress/plugin-pwa@next
1515
```
1616

1717
## 使用

Diff for: packages/docs/docs/zh/plugin/official/plugin-register-components.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ metaTitle: 注册组件的插件 | VuePress
1010
## 安装
1111

1212
```bash
13-
yarn add -D @vuepress/plugin-register-components
14-
# OR npm install -D @vuepress/plugin-register-components
13+
yarn add -D @vuepress/plugin-register-components@next
14+
# OR npm install -D @vuepress/plugin-register-components@next
1515
```
1616

1717
## 使用

Diff for: packages/docs/docs/zh/plugin/official/plugin-search.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ metaTitle: Search 插件 | VuePress
1010
## 安装
1111

1212
```bash
13-
yarn add -D @vuepress/plugin-search
14-
# OR npm install -D @vuepress/plugin-search
13+
yarn add -D @vuepress/plugin-search@next
14+
# OR npm install -D @vuepress/plugin-search@next
1515
```
1616

1717
::: tip

0 commit comments

Comments
 (0)