From 4c102153333f8af1e222b9aa7cfc2d64f78a43a6 Mon Sep 17 00:00:00 2001
From: pengzhanbo <volodymyr@foxmail.com>
Date: Wed, 15 Feb 2023 01:00:49 +0800
Subject: [PATCH] docs(plugin-blog-data): add doc

---
 packages/plugin-blog-data/README.md | 30 +++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)
 create mode 100644 packages/plugin-blog-data/README.md

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 | (<T>(prev: T, next: T) => boolean)
+  excerpt?: boolean
+  extendBlogData?: <T = any>(page: T) => Record<string, any>
+}
+```