提交 b476ba47 编写于 作者: U ULIVZ

docs: plugins documentation placeholder

上级 4cc317f2
# @vuepress/markdown
> markdown for vuepress
\ No newline at end of file
> markdown for vuepress
## Usage
```javascript
const createMarkdown = require('@vuepress/markdown')
const md = createMarkdown(/* options */)
```
## Options
### slugify
- TODO
### externalLinks
- TODO
### anchor
- TODO
### toc
- TODO
### lineNumbers
- TODO
### beforeInstantiate
- TODO
### afterInstantiate
- TODO
......@@ -6,10 +6,10 @@
```javascript
module.exports = {
plugins: ['back-to-top']
plugins: ['@vuepress/back-to-top']
}
```
## Options
No options for now.
\ No newline at end of file
No options for now.
# @vuepress/plugin-blog
> theme plugin for vuepress
## Usage
```javascript
module.exports = {
plugins: ['@vuepress/blog']
}
```
## Options
### pageEnhancers
- Type: `function`
- Default: `/i18n/`
### categoryIndexPageUrl
- Type: `string`
- Default: `/category/`
### tagIndexPageUrl
- Type: `string`
- Default: `/tag/`
......@@ -2,6 +2,14 @@
> google-analytics plugin for vuepress
## Usage
```javascript
module.exports = {
plugins: ['@vuepress/google-analytics']
}
```
## Options
### ga
......
......@@ -2,11 +2,19 @@
> i18n-ui plugin for vuepress
## Plugin Options
## Usage
```javascript
module.exports = {
plugins: ['@vuepress/i18n-ui']
}
```
## Options
### route
- Type: `string`
- Default: `/i18n/`
Path to the i18n ui page.
\ No newline at end of file
Path to the i18n ui page.
......@@ -4,6 +4,14 @@
> Note that this plugin has been included in the core.
## Usage
```js
module.exports = {
plugins: ['@vuepress/last-updated']
}
```
## Options
### transformer
......
# @vuepress/plugin-medium-zoom
> medium-zoom plugin for vuepress
\ No newline at end of file
> medium-zoom plugin for vuepress
## Usage
```javascript
module.exports = {
plugins: ['@vuepress/medium-zoom']
}
```
......@@ -2,3 +2,32 @@
> pagination plugin for vuepress
## Usage
```javascript
module.exports = {
plugins: ['@vuepress/pagination']
}
```
## postsFilter
- Type: `function`
- Default:
```js
(({ type }) => type === 'post')`
```
## postsSorter
- Type: `function`
- Default:
```js
((prev, next) => {
const prevTime = new Date(prev.frontmatter.date).getTime()
const nextTime = new Date(next.frontmatter.date).getTime()
return prevTime - nextTime > 0 ? -1 : 1
})
```
......@@ -2,6 +2,14 @@
> PWA plugin for vuepress
## Usage
```javascript
module.exports = {
plugins: ['@vuepress/pwa']
}
```
## Options
### serviceWorker
......
......@@ -39,4 +39,4 @@ import SearchBox from '@SearchBox'
- Type: `number`
- Default: `true`
Set the maximum number of results for search
Set the maximum number of results for search.
......@@ -6,5 +6,5 @@
The default theme has the following plugin built in:
- @vuepress/plugin-active-header-links
- @vuepress/plugin-google-analytics
\ No newline at end of file
- [@vuepress/plugin-active-header-links](https://github.com/vuejs/vuepress/tree/master/packages/@vuepress/plugin-active-header-links)
- [@vuepress/plugin-google-analytics](https://github.com/vuejs/vuepress/tree/master/packages/%40vuepress/plugin-google-analytics)
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册