# MyBrain

**Repository Path**: xshoushi/my-brain

## Basic Information

- **Project Name**: MyBrain
- **Description**: MyBrain —— 属于你的本地优先第二大脑
/n

MyBrain 是一个基于 Tauri + Vue 3 构建的本地优先个人知识工作站，集 Markdown笔记、知识库、事件追踪、待办提醒与全文搜索于一体，让个人知识沉淀与检索完全掌控在本地。
- **Primary Language**: TypeScript
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2026-07-06
- **Last Updated**: 2026-07-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# MyBrain

本地优先的个人知识工作站。所有数据保存在你指定的本地目录中，无需联网即可使用。

## 功能特性

- **首页概览**：最近编辑笔记、今日待办、快捷入口，点击品牌 Logo 随时回到首页。
- **知识库**：树形目录管理 Markdown 笔记，支持标签、状态（草稿/完善中/已归档）与全文搜索。
- **日常笔记**：按日期自动生成每日笔记，快速记录想法与灵感。
- **会议纪要**：基于模板生成会议记录，支持议题、讨论、决议、待办，并可关联项目。
- **项目记录**：管理项目信息，会议纪要可选择关联到指定项目。
- **待办聚合**：自动从所有笔记中提取 `- [ ] 任务 @时间 #标签` 形式的待办，支持完成、延期、历史追踪与到期提醒。
- **提醒通知**：待办到期前通过 Windows 通知提醒。
- **全文搜索**：顶部搜索框快速检索笔记内容与标题，结果高亮显示。
- **图片与附件**：截图粘贴、拖拽上传、文件选择均可保存到对应库根目录的 `images/` 文件夹，Markdown 中写入相对路径，便于迁移。
- **可配置数据目录**：支持为日常笔记、知识库、事件追踪分别设置独立的数据目录；未设置时使用默认工作空间。
- **主题设置**：支持浅色、深色、跟随系统三种主题。

## 技术栈

- Tauri 2.x + Rust
- Vue 3 + TypeScript + Vite 5
- Pinia
- Vue Router（hash 模式）
- Arco Design Vue
- Milkdown（Markdown 编辑器）
- minisearch / date-fns / uuid

## 开发

需要先安装 [Rust](https://www.rust-lang.org/tools/install) 工具链。

```bash
npm install
npm run tauri:dev
```

开发时会启动 Vite dev server 并加载 Tauri 应用窗口。

## 打包

```bash
npm run tauri:build
```

打包产物位于 `src-tauri/target/release/bundle/`。

## 数据目录

默认工作空间：

```
{exe_dir}/data
```

默认目录结构：

```
data/
├── knowledge/          # 知识库笔记
├── daily/              # 日常笔记（按 yyyy/MM 组织）
├── meetings/           # 会议纪要（按 yyyy/MM 组织）
├── events/
│   └── projects/       # 项目记录
├── attachments/        # 通用附件
└── inbox.md            # 收集箱
```

每个库的根目录下会自动创建 `images/` 文件夹，用于存放该库笔记中的图片与附件。

配置文件：

```
{exe_dir}/config/app-config.json
```

配置内容包括当前工作空间、历史工作空间、主题、通知、数据目录映射等。

## 快捷键

| 快捷键 | 作用 |
| --- | --- |
| `Ctrl + Shift + T` | 在编辑器中插入待办任务 |
| `Ctrl + V` | 粘贴剪贴板图片到编辑器 |

## 文档

- [用户手册](./docs/MANUAL.md)
- [代码结构说明](./docs/ARCHITECTURE.md)
- [研发路线图](./docs/TODO.md)

## 许可证

Apache License 2.0