上下文、描述文档更新

This commit is contained in:
2025-10-12 06:10:10 +08:00
parent d1365aaaa5
commit 3957a7d3b2
2 changed files with 129 additions and 2 deletions

View File

@@ -27,7 +27,7 @@
├── src/
│ ├── common/ # 全局样式和通用工具
│ ├── components/ # 可复用的 Vue 组件 (Header, NoteItem, FolderItem)
│ ├── pages/ # 页面级别的 Vue 组件 (NoteList, NoteDetail, NoteEditor, Folder, Settings)
│ ├── pages/ # 页面级别的 Vue 组件 (NoteList, NoteEditor, Folder, Settings)
│ ├── stores/ # Pinia 状态管理 stores
│ │ └── useAppStore.js # 全局状态管理 store
│ ├── utils/ # 工具函数
@@ -48,6 +48,10 @@
* 基于 Vite支持热更新。
* **构建生产版本**: `npm run build`
* 使用 Vite 构建,并同步到 Capacitor 项目 (`npx cap sync`)。
* **构建PWA版本**: `npm run build:pwa`
* 构建PWA版本的应用
* **部署PWA版本**: `npm run deploy:pwa`
* 构建并部署PWA版本到FTP服务器
* **在 Android 设备上运行**: `npm run android`
* 需要预先配置好 Android 开发环境。
@@ -59,6 +63,7 @@
* **置顶功能**: 支持将便签置顶显示在列表顶部
* **图片标记**: 可以标记便签中是否包含图片
* **滑动删除**: 支持右滑显示删除按钮,带有阻尼效果的交互体验
* **富文本编辑**: 支持加粗、居中、待办事项、列表、标题、引用等格式
### 文件夹管理
* **分类组织**: 支持创建文件夹对便签进行分类管理
@@ -111,11 +116,20 @@
* 每个组件应该附带 `README.MD` 文档。
* 组件编写应遵循项目中已有的风格。
### Header 组件
* **动态按钮**: 根据页面状态显示不同的操作按钮(新建、保存、插入图片)
* **文件夹管理**: 支持文件夹展开/收起功能
### NoteItem 组件
* **滑动交互**: 支持右滑显示删除按钮,带有阻尼效果
* **状态切换**: 支持星标和置顶状态的切换
* **视觉反馈**: 滑动时便签夹会切换状态,提供直观的交互反馈
### RichTextEditor 组件
* **富文本编辑**: 支持多种文本格式(加粗、居中、待办事项、列表、标题、引用)
* **图片插入**: 支持插入图片功能
* **工具栏**: 提供浮动工具栏,支持格式化操作
## 页面
* 页面使用 Composition API (setup语法糖) 编写。
@@ -127,6 +141,12 @@
* **搜索功能**: 提供便签搜索功能
* **交互反馈**: 显示便签总数和置顶便签数量
### NoteEditorPage
* **编辑模式**: 支持新建和编辑便签
* **富文本编辑**: 集成RichTextEditor组件支持丰富的文本格式
* **图片插入**: 支持通过工具栏插入图片
* **状态管理**: 根据路由参数判断是新建还是编辑模式
## 状态管理 (Pinia)
项目现在使用 Pinia 作为状态管理解决方案,主要特点包括:
@@ -154,4 +174,8 @@
### 增强的便签功能
* **置顶支持**: 便签可以置顶显示在列表顶部
* **图片标记**: 可以标记便签是否包含图片
* **排序优化**: 置顶便签优先显示,按更新时间排序
* **排序优化**: 置顶便签优先显示,按更新时间排序
### PWA 支持
* **离线使用**: 支持构建PWA版本可离线使用
* **自动部署**: 支持一键构建并部署到FTP服务器