From e82186ce68a55aaee320edf27f0082240d12ad39 Mon Sep 17 00:00:00 2001
From: pengzhanbo <volodymyr@foxmail.com>
Date: Wed, 15 Feb 2023 01:02:10 +0800
Subject: [PATCH] docs(plugin-notes-data): add docs

---
 packages/plugin-notes-data/README.md | 29 ++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)

diff --git a/packages/plugin-notes-data/README.md b/packages/plugin-notes-data/README.md
index f13efb9e..a81bc06e 100644
--- a/packages/plugin-notes-data/README.md
+++ b/packages/plugin-notes-data/README.md
@@ -16,3 +16,32 @@ module.exports = {
   // ...
 }
 ```
+
+## Options
+
+``` ts
+type NotesDataOptions = {
+  dir: string
+  link: string
+  include?: string | string[]
+  exclude?: string | string[]
+  notes: NotesItem[]
+}
+
+type NotesItem = {
+  dir: string
+  link: string
+  text: string
+  sidebar?: NotesSidebar | 'auto'
+}
+
+type NotesSidebar = (NotesSidebarItem | string)[]
+
+type NotesSidebarItem = {
+  text?: string
+  link?: string
+  dir?: string
+  collapsed?: boolean
+  items?: NotesSidebar
+}
+```