add vitepress docs

2026-09-21 16:05:14 +08:00
parent b435bf992e
commit 37cf38fe27
73 changed files with 7003 additions and 802 deletions
@@ -0,0 +1,37 @@
+# NotifyEditor 通知编辑器
+
+以 `NotifyDetail` 为数据模型的通知编辑表单，正文部分复用文章编辑器。
+
+## 基础用法
+
+:::preview 基础用法 || 通知复用文章编辑器，同时保留主题等自有字段
+
+demo-preview=../demos/notify-editor/basic.vue
+
+:::
+
+## 何时使用
+
+需要编辑系统通知、站内信等内容时使用。通知与文章的差别只在元数据，正文能力完全一致。
+
+## 数据模型
+
+`NotifyDetail` 只约束正文相关字段，主题、状态等业务字段由外层维护并原样保留：
+
+| 字段 | 说明 |
+| --- | --- |
+| `content` | 正文内容。 |
+| `contentType` | 正文类型，支持 `TEXT`、`TIP_TAP`。 |
+| `attachmentList` | 附件列表。 |
+
+## 提交内容
+
+```ts
+const detail = await editorRef.value?.submit();
+```
+
+与文章编辑器一致，`submit()` 会等待未完成的媒体上传。
+
+## API
+
+<api-table name="NotifyEditor" />