# memo

**Repository Path**: hua-hy/memo

## Basic Information

- **Project Name**: memo
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2026-07-11
- **Last Updated**: 2026-07-13

## Categories & Tags

**Categories**: Uncategorized

**Tags**: 本地便签, Electron, vue3

## README

# Memo - Windows 本地便签工具

简体中文 | [English](./README_EN.md)

## 项目简介

Memo 是一款 Windows 本地自用便签工具，采用 Electron + Vue3 技术栈开发。专注于本地数据存储，隐私优先，无需云端同步，适合需要离线使用且注重隐私的用户。

## 技术栈

- **桌面框架**: Electron
- **前端框架**: Vue 3
- **构建工具**: electron-vite
- **打包工具**: electron-builder
- **数据存储**: lowdb (JSON 文件存储)
- **图标处理**: sharp, ico

## 功能特性

### 核心功能

- 📝 **笔记编辑** - 支持富文本便签编辑
- 🖥️ **窗口交互** - 悬浮便签窗口，支持展开/折叠
- ⌨️ **全局快捷键** - 快速创建和访问便签
- 💾 **本地存储** - 数据保存在本地 JSON 文件，隐私安全
- 📋 **系统托盘** - 后台常驻，托盘菜单快速操作
- 🔍 **搜索功能** - 快速搜索便签内容
- 🏷️ **标签管理** - 标签面板管理便签分类

### 窗口类型

- **便签窗口** - 可悬浮、可吸附的便签编辑窗口
- **管理窗口** - 便签列表管理界面
- **标签面板** - 侧边标签管理面板

## 快速开始

### 环境要求

- Node.js 18+
- npm 9+

### 安装依赖

```bash
npm install
```

### 开发模式

```bash
npm run dev
```

### 构建打包

```bash
npm run build
```

打包完成后，可执行文件位于 `dist` 目录下。

## 项目结构

```
memo/
├── src/
│   ├── main/           # Electron 主进程
│   │   └── index.js   # 主进程入口
│   ├── preload/       # 预加载脚本
│   │   └── index.js
│   └── renderer/      # 渲染进程 (Vue)
│       ├── views/     # Vue 组件
│       ├── App.vue
│       ├── main.js
│       └── style.css
├── assets/             # 静态资源
│   ├── icon.ico
│   ├── icon.svg
│   └── tray-icon.png
├── scripts/           # 构建脚本
│   ├── build-icon.js
│   └── after-pack.js
├── index.html         # 便签窗口入口
├── manager.html      # 管理窗口入口
├── tag.html          # 标签面板入口
├── electron.vite.config.js
├── electron-builder.json
└── package.json
```

## 数据存储

默认数据存储路径：`用户数据目录/memo/data.json`

可在设置中自定义数据存储路径。

## 全局快捷键

- `Ctrl+Shift+N` - 新建便签
- `Ctrl+Shift+M` - 打开管理窗口

## 隐私说明

- 所有数据存储在本地，不上传至任何服务器
- 无需联网即可使用
- 数据文件由用户自行管理和备份

## 许可证

MIT License

## 贡献指南

欢迎提交 Issue 和 Pull Request。