Skip to content

Commit 3771f59

Browse files
committed
docs($cn): rest official plugins
1 parent 0d1a1a5 commit 3771f59

15 files changed

+53
-59
lines changed

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: back-to-top
44

55
# @vuepress/plugin-back-to-top
66

7-
> Back-to-top plugin.
7+
> Back-to-top plugin
88
99
## Install
1010

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: blog
44

55
# @vuepress/plugin-blog
66

7-
> Blog plugin.
7+
> Blog plugin
88
99
## Install
1010

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: google-analytics
44

55
# @vuepress/plugin-google-analytics
66

7-
> Google analytics plugin for vuepress
7+
> Google analytics plugin
88
99
## Install
1010

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: i18n-ui
44

55
# @vuepress/plugin-i18n-ui
66

7-
> i18n-ui plugin for vuepress
7+
> i18n-ui plugin
88
99
## Install
1010

Diff for: packages/docs/docs/plugin/official/plugin-last-updated.md

+3-8
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,9 @@ title: last-updated
66

77
> last-updated plugin for vuepress
88
9-
> Note that this plugin has been included in the core.
10-
11-
## Install
12-
13-
```bash
14-
yarn add -D @vuepress/plugin-pagination
15-
# OR npm install -D @vuepress/plugin-pagination
16-
```
9+
::: warning Note
10+
Note that this plugin has been included in the core, you don't need to repeat the installation.
11+
:::
1712

1813
## Usage
1914

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: medium-zoom
44

55
# @vuepress/plugin-medium-zoom
66

7-
> medium-zoom plugin for vuepress
7+
> [medium-zoom](https://github.com/francoischalifour/medium-zoom) plugin
88
99
## Install
1010

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

+5-3
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: pagination
44

55
# @vuepress/plugin-pagination
66

7-
> pagination plugin for vuepress
7+
> pagination plugin
88
99
## Install
1010

@@ -21,7 +21,9 @@ module.exports = {
2121
}
2222
```
2323

24-
## postsFilter
24+
## Options
25+
26+
### postsFilter
2527

2628
- Type: `function`
2729
- Default:
@@ -30,7 +32,7 @@ module.exports = {
3032
(({ type }) => type === 'post')`
3133
```
3234

33-
## postsSorter
35+
### postsSorter
3436

3537
- Type: `function`
3638
- Default:

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: pwa
44

55
# @vuepress/plugin-pwa
66

7-
> PWA plugin.
7+
> PWA plugin
88
99
## Install
1010

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: search
44

55
# @vuepress/plugin-search
66

7-
> [Headers](../../miscellaneous/glossary.md#headers)-based search plugin.
7+
> [Headers](../../miscellaneous/glossary.md#headers)-based search plugin
88
99
## Install
1010

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

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,16 @@ title: back-to-top
44

55
# @vuepress/plugin-back-to-top
66

7-
> Back-to-top plugin.
7+
> back-to-top 插件.
88
9-
## Install
9+
## 安装
1010

1111
```bash
1212
yarn add -D @vuepress/plugin-back-to-top
1313
# OR npm install -D @vuepress/plugin-back-to-top
1414
```
1515

16-
## Usage
16+
## 使用
1717

1818
```javascript
1919
module.exports = {

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

+7-7
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,28 @@ title: google-analytics
44

55
# @vuepress/plugin-google-analytics
66

7-
> Google analytics plugin for vuepress
7+
> Google analytics 插件
88
9-
## Install
9+
## 安装
1010

1111
```bash
1212
yarn add -D @vuepress/plugin-google-analytics
1313
# OR npm install -D @vuepress/plugin-google-analytics
1414
```
1515

16-
## Usage
16+
## 使用
1717

1818
```javascript
1919
module.exports = {
2020
plugins: ['@vuepress/google-analytics']
2121
}
2222
```
2323

24-
## Options
24+
## 选项
2525

2626
### ga
2727

28-
- Type: `string`
29-
- Default: `undefined`
28+
- 类型: `string`
29+
- 默认值: `undefined`
3030

31-
Provide the Google Analytics ID to enable integration.
31+
Google Analytics ID

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

+7-7
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,28 @@ title: i18n-ui
44

55
# @vuepress/plugin-i18n-ui
66

7-
> i18n-ui plugin for vuepress
7+
> i18n-ui 插件。
88
9-
## Install
9+
## 安装
1010

1111
```bash
1212
yarn add -D @vuepress/plugin-i18n-ui
1313
# OR npm install -D @vuepress/plugin-i18n-ui
1414
```
1515

16-
## Usage
16+
## 使用
1717

1818
```javascript
1919
module.exports = {
2020
plugins: ['@vuepress/i18n-ui']
2121
}
2222
```
2323

24-
## Options
24+
## 选项
2525

2626
### route
2727

28-
- Type: `string`
29-
- Default: `/i18n/`
28+
- 类型: `string`
29+
- 默认值: `/i18n/`
3030

31-
Path to the i18n ui page.
31+
i18n ui页面的路径。

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

+9-14
Original file line numberDiff line numberDiff line change
@@ -4,33 +4,28 @@ title: last-updated
44

55
# @vuepress/plugin-last-updated
66

7-
> last-updated plugin for vuepress
7+
> last-updated 插件。
88
9-
> Note that this plugin has been included in the core.
9+
::: warning 注意
10+
注意,vuepress 的 core 中已经包含此插件,你无需再重复安装。
11+
:::
1012

11-
## Install
12-
13-
```bash
14-
yarn add -D @vuepress/plugin-pagination
15-
# OR npm install -D @vuepress/plugin-pagination
16-
```
17-
18-
## Usage
13+
## 使用
1914

2015
```js
2116
module.exports = {
2217
plugins: ['@vuepress/last-updated']
2318
}
2419
```
2520

26-
## Options
21+
## 选项
2722

2823
### transformer
2924

30-
- Type: `function`
31-
- Default: `undefined`
25+
- 类型: `function`
26+
- 默认值: `undefined`
3227

33-
By default, this plugin produces a 13-bit timestamp for each page, you can also pass in a transformer to convert it to any format that you want.
28+
默认情况下,本插件为每个页面生成一个 13 位的时间戳,你可以传入一个 transformer 将其转换为你想要的任何格式。
3429

3530
``` javascript
3631
const timeago = require("timeago.js");

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: medium-zoom
44

55
# @vuepress/plugin-medium-zoom
66

7-
> medium-zoom plugin for vuepress
7+
> [medium-zoom](https://github.com/francoischalifour/medium-zoom) 插件
88
99
## Install
1010

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

+11-9
Original file line numberDiff line numberDiff line change
@@ -4,36 +4,38 @@ title: pagination
44

55
# @vuepress/plugin-pagination
66

7-
> pagination plugin for vuepress
7+
> 分页器插件
88
9-
## Install
9+
## 安装
1010

1111
```bash
1212
yarn add -D @vuepress/plugin-pagination
1313
# OR npm install -D @vuepress/plugin-pagination
1414
```
1515

16-
## Usage
16+
## 使用
1717

1818
```javascript
1919
module.exports = {
2020
plugins: ['@vuepress/pagination']
2121
}
2222
```
2323

24-
## postsFilter
24+
## 选项
2525

26-
- Type: `function`
27-
- Default:
26+
### postsFilter
27+
28+
- 类型: `function`
29+
- 默认值:
2830

2931
```js
3032
(({ type }) => type === 'post')`
3133
```
3234

33-
## postsSorter
35+
### postsSorter
3436

35-
- Type: `function`
36-
- Default:
37+
- 类型: `function`
38+
- 默认值:
3739

3840
```js
3941
((prev, next) => {

0 commit comments

Comments
 (0)