docs: plugins documentation placeholder

vuejs · Oct 2, 2018 · b476ba4 · b476ba4
1 parent 4cc317f
commit b476ba4
Show file tree

Hide file tree

Showing 11 changed files with 143 additions and 9 deletions.
diff --git a/packages/@vuepress/markdown/README.md b/packages/@vuepress/markdown/README.md
@@ -1,3 +1,40 @@
 # @vuepress/markdown
 
-> markdown for vuepress
+> 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
diff --git a/packages/@vuepress/plugin-back-to-top/README.md b/packages/@vuepress/plugin-back-to-top/README.md
@@ -6,10 +6,10 @@
 
 ```javascript
 module.exports = {
-  plugins: ['back-to-top'] 
+  plugins: ['@vuepress/back-to-top'] 
 }
 ```
 
 ## Options
 
-No options for now.
+No options for now.
diff --git a/packages/@vuepress/plugin-blog/README.md b/packages/@vuepress/plugin-blog/README.md
@@ -1,3 +1,31 @@
 # @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/`
+
+
+
diff --git a/packages/@vuepress/plugin-google-analytics/README.md b/packages/@vuepress/plugin-google-analytics/README.md
@@ -2,6 +2,14 @@
 
 > google-analytics plugin for vuepress
 
+## Usage
+
+```javascript
+module.exports = {
+  plugins: ['@vuepress/google-analytics'] 
+}
+```
+
 ## Options
 
 ### ga

diff --git a/packages/@vuepress/plugin-i18n-ui/README.md b/packages/@vuepress/plugin-i18n-ui/README.md
@@ -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.
+Path to the i18n ui page.
diff --git a/packages/@vuepress/plugin-last-updated/README.md b/packages/@vuepress/plugin-last-updated/README.md
@@ -4,6 +4,14 @@
 
 > Note that this plugin has been included in the core.
 
+## Usage
+
+```js
+module.exports = {
+  plugins: ['@vuepress/last-updated'] 
+}
+```
+
 ## Options
 
 ### transformer

diff --git a/packages/@vuepress/plugin-medium-zoom/README.md b/packages/@vuepress/plugin-medium-zoom/README.md
@@ -1,3 +1,11 @@
 # @vuepress/plugin-medium-zoom
 
-> medium-zoom plugin for vuepress
+> medium-zoom plugin for vuepress
+
+## Usage
+
+```javascript
+module.exports = {
+  plugins: ['@vuepress/medium-zoom'] 
+}
+```
diff --git a/packages/@vuepress/plugin-pagination/README.md b/packages/@vuepress/plugin-pagination/README.md
@@ -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
+})
+```
diff --git a/packages/@vuepress/plugin-pwa/README.md b/packages/@vuepress/plugin-pwa/README.md
@@ -2,6 +2,14 @@
 
 > PWA plugin for vuepress
 
+## Usage
+
+```javascript
+module.exports = {
+  plugins: ['@vuepress/pwa'] 
+}
+```
+
 ## Options
 
 ### serviceWorker

diff --git a/packages/@vuepress/plugin-search/README.md b/packages/@vuepress/plugin-search/README.md
@@ -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.
diff --git a/packages/@vuepress/theme-default/README.md b/packages/@vuepress/theme-default/README.md
@@ -6,5 +6,5 @@
 
 The default theme has the following plugin built in:
 
-- @vuepress/plugin-active-header-links
-- @vuepress/plugin-google-analytics
+- [@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)