From 3678b7f34b692e9e56141101e2c9e8b2d627a677 Mon Sep 17 00:00:00 2001
From: Hufe921 <huangyunfeihufe@hotmail.com>
Date: Thu, 5 Jan 2023 19:30:24 +0800
Subject: [PATCH] docs:add global api

---
 docs/.vitepress/config.ts |  6 ++++++
 docs/guide/api.md         | 21 +++++++++++++++++++++
 2 files changed, 27 insertions(+)
 create mode 100644 docs/guide/api.md

diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts
index 720b3fb..dd1aebb 100644
--- a/docs/.vitepress/config.ts
+++ b/docs/.vitepress/config.ts
@@ -49,6 +49,12 @@ export default defineConfig({
           { text: '内部右键菜单', link: '/guide/contextmenu-internal' },
           { text: '自定义右键菜单', link: '/guide/contextmenu-custom' }
         ]
+      },
+      {
+        text: 'API',
+        items: [
+          { text: '全局API', link: '/guide/api' }
+        ]
       }
     ],
     socialLinks: [{
diff --git a/docs/guide/api.md b/docs/guide/api.md
new file mode 100644
index 0000000..4cd6f8c
--- /dev/null
+++ b/docs/guide/api.md
@@ -0,0 +1,21 @@
+# 全局API
+
+## 使用方式
+
+```javascript
+import Editor from "@hufe921/canvas-editor"
+
+const instance = new Editor(container, <IElement[]>data, options)
+instance.apiName()
+```
+## destroy
+功能：销毁编辑器
+
+用法：
+```javascript
+instance.destroy()
+```
+
+::: warning
+仅销毁编辑器dom及相关事件，菜单栏、工具栏、外部变量等需自行处理。
+:::
\ No newline at end of file