Skip to content

Commit 83cdc8b

Browse files
committed
docs: @vuepress/plugin-blog
1 parent e20d64c commit 83cdc8b

File tree

4 files changed

+63
-26
lines changed

4 files changed

+63
-26
lines changed
+1-25
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,7 @@
11
# @vuepress/plugin-blog
22

3-
> theme plugin for vuepress
3+
> blog plugin for vuepress
44
5-
## Usage
6-
7-
```javascript
8-
module.exports = {
9-
plugins: ['@vuepress/blog']
10-
}
11-
```
12-
13-
## Options
14-
15-
### pageEnhancers
16-
17-
- Type: `function`
18-
- Default: `/i18n/`
19-
20-
### categoryIndexPageUrl
21-
22-
- Type: `string`
23-
- Default: `/category/`
24-
25-
### tagIndexPageUrl
26-
27-
- Type: `string`
28-
- Default: `/tag/`
295

306

317

packages/docs/docs/.vuepress/config.js

+2-1
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,8 @@ function getPluginSidebar (pluginTitle, pluginIntro, officialPluginTitle) {
127127
collapsable: false,
128128
children: [
129129
'official/plugin-search',
130-
'official/plugin-pwa'
130+
'official/plugin-pwa',
131+
'official/plugin-blog',
131132
]
132133
}
133134
]
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# @vuepress/plugin-blog
2+
3+
> Blog plugin.
4+
5+
## Install
6+
7+
```bash
8+
yarn add -D @vuepress/plugin-blog
9+
# OR npm install -D @vuepress/plugin-blog
10+
```
11+
12+
## Usage
13+
14+
```javascript
15+
module.exports = {
16+
plugins: ['@vuepress/blog']
17+
}
18+
```
19+
20+
## Options
21+
22+
### categoryIndexPageUrl
23+
24+
- Type: `string`
25+
- Default: `/category/`
26+
27+
### tagIndexPageUrl
28+
29+
- Type: `string`
30+
- Default: `/tag/`
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# @vuepress/plugin-blog
2+
3+
> Blog plugin.
4+
5+
## Install
6+
7+
```bash
8+
yarn add -D @vuepress/plugin-blog
9+
# OR npm install -D @vuepress/plugin-blog
10+
```
11+
12+
## Usage
13+
14+
```javascript
15+
module.exports = {
16+
plugins: ['@vuepress/blog']
17+
}
18+
```
19+
20+
## Options
21+
22+
### categoryIndexPageUrl
23+
24+
- Type: `string`
25+
- Default: `/category/`
26+
27+
### tagIndexPageUrl
28+
29+
- Type: `string`
30+
- Default: `/tag/`

0 commit comments

Comments
 (0)