File tree 11 files changed +143
-9
lines changed
11 files changed +143
-9
lines changed Original file line number Diff line number Diff line change 1
1
# @vuepress/markdown
2
2
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
Original file line number Diff line number Diff line change 6
6
7
7
``` javascript
8
8
module .exports = {
9
- plugins: [' back-to-top' ]
9
+ plugins: [' @vuepress/ back-to-top' ]
10
10
}
11
11
```
12
12
13
13
## Options
14
14
15
- No options for now.
15
+ No options for now.
Original file line number Diff line number Diff line change 1
1
# @vuepress/plugin-blog
2
2
3
3
> 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
+
Original file line number Diff line number Diff line change 2
2
3
3
> google-analytics plugin for vuepress
4
4
5
+ ## Usage
6
+
7
+ ``` javascript
8
+ module .exports = {
9
+ plugins: [' @vuepress/google-analytics' ]
10
+ }
11
+ ```
12
+
5
13
## Options
6
14
7
15
### ga
Original file line number Diff line number Diff line change 2
2
3
3
> i18n-ui plugin for vuepress
4
4
5
- ## Plugin Options
5
+ ## Usage
6
+
7
+ ``` javascript
8
+ module .exports = {
9
+ plugins: [' @vuepress/i18n-ui' ]
10
+ }
11
+ ```
12
+
13
+ ## Options
6
14
7
15
### route
8
16
9
17
- Type: ` string `
10
18
- Default: ` /i18n/ `
11
19
12
- Path to the i18n ui page.
20
+ Path to the i18n ui page.
Original file line number Diff line number Diff line change 4
4
5
5
> Note that this plugin has been included in the core.
6
6
7
+ ## Usage
8
+
9
+ ``` js
10
+ module .exports = {
11
+ plugins: [' @vuepress/last-updated' ]
12
+ }
13
+ ```
14
+
7
15
## Options
8
16
9
17
### transformer
Original file line number Diff line number Diff line change 1
1
# @vuepress/plugin-medium-zoom
2
2
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
+ ```
Original file line number Diff line number Diff line change 2
2
3
3
> pagination plugin for vuepress
4
4
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
+ ` ` `
Original file line number Diff line number Diff line change 2
2
3
3
> PWA plugin for vuepress
4
4
5
+ ## Usage
6
+
7
+ ``` javascript
8
+ module .exports = {
9
+ plugins: [' @vuepress/pwa' ]
10
+ }
11
+ ```
12
+
5
13
## Options
6
14
7
15
### serviceWorker
Original file line number Diff line number Diff line change @@ -39,4 +39,4 @@ import SearchBox from '@SearchBox'
39
39
- Type: ` number `
40
40
- Default: ` true `
41
41
42
- Set the maximum number of results for search
42
+ Set the maximum number of results for search.
Original file line number Diff line number Diff line change 6
6
7
7
The default theme has the following plugin built in:
8
8
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 )
You can’t perform that action at this time.
0 commit comments