Skip to content

Commit b476ba4

Browse files
committed
docs: plugins documentation placeholder
1 parent 4cc317f commit b476ba4

File tree

11 files changed

+143
-9
lines changed

11 files changed

+143
-9
lines changed

packages/@vuepress/markdown/README.md

+38-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,40 @@
11
# @vuepress/markdown
22

3-
> markdown for vuepress
3+
> markdown for vuepress
4+
5+
## Usage
6+
7+
```javascript
8+
const createMarkdown = require('@vuepress/markdown')
9+
const md = createMarkdown(/* options */)
10+
```
11+
12+
## Options
13+
14+
### slugify
15+
16+
- TODO
17+
18+
### externalLinks
19+
20+
- TODO
21+
22+
### anchor
23+
24+
- TODO
25+
26+
### toc
27+
28+
- TODO
29+
30+
### lineNumbers
31+
32+
- TODO
33+
34+
### beforeInstantiate
35+
36+
- TODO
37+
38+
### afterInstantiate
39+
40+
- TODO

packages/@vuepress/plugin-back-to-top/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@
66

77
```javascript
88
module.exports = {
9-
plugins: ['back-to-top']
9+
plugins: ['@vuepress/back-to-top']
1010
}
1111
```
1212

1313
## Options
1414

15-
No options for now.
15+
No options for now.
+28
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,31 @@
11
# @vuepress/plugin-blog
22

33
> theme plugin for vuepress
4+
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/`
29+
30+
31+

packages/@vuepress/plugin-google-analytics/README.md

+8
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,14 @@
22

33
> google-analytics plugin for vuepress
44
5+
## Usage
6+
7+
```javascript
8+
module.exports = {
9+
plugins: ['@vuepress/google-analytics']
10+
}
11+
```
12+
513
## Options
614

715
### ga

packages/@vuepress/plugin-i18n-ui/README.md

+10-2
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,19 @@
22

33
> i18n-ui plugin for vuepress
44
5-
## Plugin Options
5+
## Usage
6+
7+
```javascript
8+
module.exports = {
9+
plugins: ['@vuepress/i18n-ui']
10+
}
11+
```
12+
13+
## Options
614

715
### route
816

917
- Type: `string`
1018
- Default: `/i18n/`
1119

12-
Path to the i18n ui page.
20+
Path to the i18n ui page.

packages/@vuepress/plugin-last-updated/README.md

+8
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,14 @@
44
55
> Note that this plugin has been included in the core.
66
7+
## Usage
8+
9+
```js
10+
module.exports = {
11+
plugins: ['@vuepress/last-updated']
12+
}
13+
```
14+
715
## Options
816

917
### transformer
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
11
# @vuepress/plugin-medium-zoom
22

3-
> medium-zoom plugin for vuepress
3+
> medium-zoom plugin for vuepress
4+
5+
## Usage
6+
7+
```javascript
8+
module.exports = {
9+
plugins: ['@vuepress/medium-zoom']
10+
}
11+
```

packages/@vuepress/plugin-pagination/README.md

+29
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,32 @@
22

33
> pagination plugin for vuepress
44
5+
## Usage
6+
7+
```javascript
8+
module.exports = {
9+
plugins: ['@vuepress/pagination']
10+
}
11+
```
12+
13+
## postsFilter
14+
15+
- Type: `function`
16+
- Default:
17+
18+
```js
19+
(({ type }) => type === 'post')`
20+
```
21+
22+
## postsSorter
23+
24+
- Type: `function`
25+
- Default:
26+
27+
```js
28+
((prev, next) => {
29+
const prevTime = new Date(prev.frontmatter.date).getTime()
30+
const nextTime = new Date(next.frontmatter.date).getTime()
31+
return prevTime - nextTime > 0 ? -1 : 1
32+
})
33+
```

packages/@vuepress/plugin-pwa/README.md

+8
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,14 @@
22

33
> PWA plugin for vuepress
44
5+
## Usage
6+
7+
```javascript
8+
module.exports = {
9+
plugins: ['@vuepress/pwa']
10+
}
11+
```
12+
513
## Options
614

715
### serviceWorker

packages/@vuepress/plugin-search/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,4 +39,4 @@ import SearchBox from '@SearchBox'
3939
- Type: `number`
4040
- Default: `true`
4141

42-
Set the maximum number of results for search
42+
Set the maximum number of results for search.

packages/@vuepress/theme-default/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,5 @@
66

77
The default theme has the following plugin built in:
88

9-
- @vuepress/plugin-active-header-links
10-
- @vuepress/plugin-google-analytics
9+
- [@vuepress/plugin-active-header-links](https://github.com/vuejs/vuepress/tree/master/packages/@vuepress/plugin-active-header-links)
10+
- [@vuepress/plugin-google-analytics](https://github.com/vuejs/vuepress/tree/master/packages/%40vuepress/plugin-google-analytics)

0 commit comments

Comments
 (0)