diff --git a/packages/plugin-blog-data/README.md b/packages/plugin-blog-data/README.md new file mode 100644 index 00000000..3ee7fd54 --- /dev/null +++ b/packages/plugin-blog-data/README.md @@ -0,0 +1,30 @@ +# `@vuepress-plume/vuepress-plugin-blog-data` + +## Install +``` +yarn add @vuepress-plume/vuepress-plugin-blog-data +``` +## Usage +``` js +// .vuepress/config.js +const { blogDataPlugin } = require('@vuepress-plume/vuepress-plugin-blog-data') +module.exports = { + //... + plugins: [ + blogDataPlugin() + ] + // ... +} +``` + +## Options + +```ts +interface BlogDataPluginOptions { + include?: string | string[] + exclude?: string | string[] + sortBy?: 'createTime' | false | ((prev: T, next: T) => boolean) + excerpt?: boolean + extendBlogData?: (page: T) => Record +} +```