diff --git a/packages/@vuepress/plugin-blog/README.md b/packages/@vuepress/plugin-blog/README.md index ecac3704..7c314402 100644 --- a/packages/@vuepress/plugin-blog/README.md +++ b/packages/@vuepress/plugin-blog/README.md @@ -1,31 +1,7 @@ # @vuepress/plugin-blog -> theme plugin for vuepress +> blog 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/docs/docs/.vuepress/config.js b/packages/docs/docs/.vuepress/config.js index cc828141..02c45f33 100644 --- a/packages/docs/docs/.vuepress/config.js +++ b/packages/docs/docs/.vuepress/config.js @@ -127,7 +127,8 @@ function getPluginSidebar (pluginTitle, pluginIntro, officialPluginTitle) { collapsable: false, children: [ 'official/plugin-search', - 'official/plugin-pwa' + 'official/plugin-pwa', + 'official/plugin-blog', ] } ] diff --git a/packages/docs/docs/plugin/official/plugin-blog.md b/packages/docs/docs/plugin/official/plugin-blog.md new file mode 100644 index 00000000..6d26bdc2 --- /dev/null +++ b/packages/docs/docs/plugin/official/plugin-blog.md @@ -0,0 +1,30 @@ +# @vuepress/plugin-blog + +> Blog plugin. + +## Install + +```bash +yarn add -D @vuepress/plugin-blog +# OR npm install -D @vuepress/plugin-blog +``` + +## Usage + +```javascript +module.exports = { + plugins: ['@vuepress/blog'] +} +``` + +## Options + +### categoryIndexPageUrl + +- Type: `string` +- Default: `/category/` + +### tagIndexPageUrl + +- Type: `string` +- Default: `/tag/` diff --git a/packages/docs/docs/zh/plugin/official/plugin-blog.md b/packages/docs/docs/zh/plugin/official/plugin-blog.md new file mode 100644 index 00000000..6d26bdc2 --- /dev/null +++ b/packages/docs/docs/zh/plugin/official/plugin-blog.md @@ -0,0 +1,30 @@ +# @vuepress/plugin-blog + +> Blog plugin. + +## Install + +```bash +yarn add -D @vuepress/plugin-blog +# OR npm install -D @vuepress/plugin-blog +``` + +## Usage + +```javascript +module.exports = { + plugins: ['@vuepress/blog'] +} +``` + +## Options + +### categoryIndexPageUrl + +- Type: `string` +- Default: `/category/` + +### tagIndexPageUrl + +- Type: `string` +- Default: `/tag/`